cbl::triplets Namespace Reference

The namespace of the functions and classes used to handle triplets of objects More...

Classes
class	Triplet
	The class Triplet. More...
class	Triplet1D
	The class Triplet1D. More...
class	Triplet1D_comoving
	The class Triplet1D_comoving. More...
class	Triplet1D_comoving_theta
	The class Triplet1D_comoving_theta. More...
class	Triplet1D_multipoles_direct
	The class Triplet1D_multipoles_direct. More...
class	Triplet1D_comoving_side
	The class Triplet1D_comoving_side. More...
class	Triplet1D_comoving_costheta
	The class Triplet1D_comoving_costheta. More...
class	Triplet1D_angular
	The class Triplet1D_angular. More...
class	Triplet2D
	The class Triplet2D. More...

Enumerations
enum class	TripletType { _comoving_theta_ , _comoving_side_ , _comoving_costheta_ , _multipoles_direct_ }
	the triplet type More...

Functions
std::vector< std::string >	TripletTypeNames ()
	return a vector containing the TripletType names More...
TripletType	TripletTypeCast (const int tripletPTypeIndex)
	cast an enum of type TripletType from its index More...
TripletType	TripletTypeCast (const std::string tripletPTypeName)
	cast an enum of type TripletType from its name More...
std::vector< TripletType >	TripletTypeCast (const std::vector< int > tripletPTypeIndeces)
	cast an enum of type TripletType from indeces More...
std::vector< TripletType >	TripletTypeCast (const std::vector< std::string > tripletPTypeNames)
	cast an enum of type TripletType from thier names More...

Detailed Description

The namespace of the functions and classes used to handle triplets of objects

The triplets namespace contains all the functions and classes to handle triplets of objects

Enumeration Type Documentation

TripletType

enum cbl::triplets::TripletType

strong

the triplet type

Enumerator
_comoving_theta_	1D triplet in comoving coordinates and angular bins
_comoving_side_	1D triplet in comoving coordinates and linear bins
_comoving_costheta_	1D triplet in comoving coordinates and linear bins of the cosine of theta
_multipoles_direct_	multipoles of the triplets

Definition at line 62 of file Triplet.h.

Function Documentation

TripletTypeCast() [1/4]

TripletType cbl::triplets::TripletTypeCast ( const int  tripletPTypeIndex )

inline

cast an enum of type TripletType from its index

Parameters

tripletPTypeIndex

the tripletPType index

Returns

object of class TripletType

Definition at line 93 of file Triplet.h.

TripletTypeCast() [2/4]

TripletType cbl::triplets::TripletTypeCast ( const std::string  tripletPTypeName )

inline

cast an enum of type TripletType from its name

Parameters

tripletPTypeName

the tripletPType name

Returns

object of class TripletType

Definition at line 102 of file Triplet.h.

TripletTypeCast() [3/4]

std::vector<TripletType> cbl::triplets::TripletTypeCast ( const std::vector< int >  tripletPTypeIndeces )

inline

cast an enum of type TripletType from indeces

Parameters

tripletPTypeIndeces

the tripletPType indeces

Returns

vector of objects of class TripletType

Definition at line 111 of file Triplet.h.

TripletTypeCast() [4/4]

std::vector<TripletType> cbl::triplets::TripletTypeCast ( const std::vector< std::string >  tripletPTypeNames )

inline

cast an enum of type TripletType from thier names

Parameters

tripletPTypeNames

the tripletPType names

Returns

vector of TripletType enums

Definition at line 120 of file Triplet.h.

TripletTypeNames()

std::vector<std::string> cbl::triplets::TripletTypeNames ( )

inline

return a vector containing the TripletType names

Returns

a vector containing the TripletType names

Definition at line 84 of file Triplet.h.