so3_types.h File Reference

#include <ssht/ssht.h>

Include dependency graph for so3_types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	so3_parameters_t

Macros
#define	SO3_COMPLEX(TYPE)   TYPE complex
#define	SO3_PI   3.141592653589793238462643383279502884197
#define	SO3_PION2   1.570796326794896619231321691639751442099
#define	SO3_SQRT2   1.41421356237309504880168872420969807856967
#define	SO3_PROMPT   "[so3] "

Enumerations
enum	so3_n_order_t { SO3_N_ORDER_ZERO_FIRST, SO3_N_ORDER_NEGATIVE_FIRST, SO3_N_ORDER_SIZE }
enum	so3_storage_t { SO3_STORAGE_PADDED, SO3_STORAGE_COMPACT, SO3_STORAGE_SIZE }
enum	so3_n_mode_t {   SO3_N_MODE_ALL, SO3_N_MODE_EVEN, SO3_N_MODE_ODD, SO3_N_MODE_MAXIMUM,   SO3_N_MODE_L, SO3_N_MODE_SIZE }
enum	so3_sampling_t { SO3_SAMPLING_MW, SO3_SAMPLING_MW_SS, SO3_SAMPLING_SIZE }

Detailed Description

Types used in SO3 package.

Author

Martin Büttner

Jason McEwen

Macro Definition Documentation

SO3_COMPLEX

#define SO3_COMPLEX

(

TYPE

)

TYPE complex

SO3_PI

#define SO3_PI   3.141592653589793238462643383279502884197

SO3_PION2

#define SO3_PION2   1.570796326794896619231321691639751442099

SO3_PROMPT

#define SO3_PROMPT   "[so3] "

SO3_SQRT2

#define SO3_SQRT2   1.41421356237309504880168872420969807856967

Enumeration Type Documentation

so3_n_mode_t

enum so3_n_mode_t

Enumerator
SO3_N_MODE_ALL	flmn are potentially non-zero for all values of n
SO3_N_MODE_EVEN	flmn are only non-zero for even n
SO3_N_MODE_ODD	flmn are only non-zero for odd n
SO3_N_MODE_MAXIMUM	flmn are only non-zero for |n| = N-1
SO3_N_MODE_L	flmn are only non-zero for |n| = el
SO3_N_MODE_SIZE	"guard" value that equals the number of usable enum values. useful in loops, for instance.

so3_n_order_t

enum so3_n_order_t

Enumerator
SO3_N_ORDER_ZERO_FIRST	order of flm-blocks in terms of n in storage is 0, -1, 1, -2, 2, ...
SO3_N_ORDER_NEGATIVE_FIRST	order of flm-blocks in terms of n in storage is ... -2, -1, 0, 1, 2, ...
SO3_N_ORDER_SIZE	"guard" value that equals the number of usable enum values. useful in loops, for instance.

so3_sampling_t

enum so3_sampling_t

Enumerator
SO3_SAMPLING_MW	McEwen and Wiaux sampling: 2*L-1 samples in alpha, in [0, 2pi). L samples in beta, in (0, pi]. 2*N-1 samples in gamma, in [0, 2pi).
SO3_SAMPLING_MW_SS	McEwen and Wiaux symmetric sampling: 2*L samples in alpha, in [0, 2pi). L+1 samples in beta, in [0, pi]. 2*N-1 samples in gamma, in [0, 2pi).
SO3_SAMPLING_SIZE	"guard" value that equals the number of usable enum values. useful in loops, for instance.

so3_storage_t

enum so3_storage_t

Enumerator
SO3_STORAGE_PADDED	left-pad each flm-array with 0s to L^2 values
SO3_STORAGE_COMPACT	do not store lm for l < |n|
SO3_STORAGE_SIZE	"guard" value that equals the number of usable enum values. useful in loops, for instance.