cbl::measure::threept Namespace Reference

The namespace of the three-point correlation function More...

Classes
class	ThreePointCorrelation
	The class ThreePointCorrelation. More...
class	ThreePointCorrelation_angular_connected
	The class ThreePointCorrelation_angular_connected. More...
class	ThreePointCorrelation_angular_reduced
	The class ThreePointCorrelation_angular_reduced. More...
class	ThreePointCorrelation_comoving_connected
	The class ThreePointCorrelation_comoving_connected. More...
class	ThreePointCorrelation_comoving_multipoles
	The class ThreePointCorrelation_comoving_multipoles. More...
class	ThreePointCorrelation_comoving_multipoles_all
	The class ThreePointCorrelation_comoving_multipoles_all. More...
class	ThreePointCorrelation_comoving_multipoles_single
	The class ThreePointCorrelation_comoving_multipoles_single. More...
class	ThreePointCorrelation_comoving_reduced
	The class ThreePointCorrelation_comoving_reduced. More...

Enumerations
enum class	ThreePType { _angular_connected_ , _angular_reduced_ , _comoving_connected_ , _comoving_reduced_ }
	the three-point correlation function type More...

Functions
std::vector< std::string >	ThreePTypeNames ()
	return a vector containing the ThreePType names More...
ThreePType	ThreePTypeCast (const int threePTypeIndex)
	cast an enum of type ThreePType from its index More...
ThreePType	ThreePTypeCast (const std::string threePTypeName)
	cast an enum of type ThreePType from its name More...
std::vector< ThreePType >	ThreePTypeCast (const std::vector< int > threePTypeIndeces)
	cast an enum of type ThreePType from indeces More...
std::vector< ThreePType >	ThreePTypeCast (const std::vector< std::string > threePTypeNames)
	cast an enum of type ThreePType from thier names More...

Detailed Description

The namespace of the three-point correlation function

The measure::threept namespace contains all the functions and classes to measure the three-point correlation function

Enumeration Type Documentation

ThreePType

enum cbl::measure::threept::ThreePType

strong

the three-point correlation function type

Enumerator
_angular_connected_	the connected three-point correlation function in angular coordinates
_angular_reduced_	the reduced three-point correlation function in angular coordinates
_comoving_connected_	the connected three-point correlation function in comoving coordinates
_comoving_reduced_	the reduced three-point correlation function in comoving coordinates

Definition at line 67 of file ThreePointCorrelation.h.

Function Documentation

ThreePTypeCast() [1/4]

ThreePType cbl::measure::threept::ThreePTypeCast ( const int  threePTypeIndex )

inline

cast an enum of type ThreePType from its index

Parameters

threePTypeIndex

the threePType index

Returns

object of class ThreePType

Definition at line 97 of file ThreePointCorrelation.h.

ThreePTypeCast() [2/4]

ThreePType cbl::measure::threept::ThreePTypeCast ( const std::string  threePTypeName )

inline

cast an enum of type ThreePType from its name

Parameters

threePTypeName

the threePType name

Returns

object of class ThreePType

Definition at line 105 of file ThreePointCorrelation.h.

ThreePTypeCast() [3/4]

std::vector<ThreePType> cbl::measure::threept::ThreePTypeCast ( const std::vector< int >  threePTypeIndeces )

inline

cast an enum of type ThreePType from indeces

Parameters

threePTypeIndeces

the threePType indeces

Returns

vector of objects of class ThreePType

Definition at line 113 of file ThreePointCorrelation.h.

ThreePTypeCast() [4/4]

std::vector<ThreePType> cbl::measure::threept::ThreePTypeCast ( const std::vector< std::string >  threePTypeNames )

inline

cast an enum of type ThreePType from thier names

Parameters

threePTypeNames

the threePType names

Returns

vector of objects of class ThreePType

Definition at line 121 of file ThreePointCorrelation.h.

ThreePTypeNames()

std::vector<std::string> cbl::measure::threept::ThreePTypeNames ( )

inline

return a vector containing the ThreePType names

Returns

a vector containing the ThreePType names

Definition at line 89 of file ThreePointCorrelation.h.