CosmoBolognaLib
Free Software C++/Python libraries for cosmological calculations
cbl::pairs Namespace Reference

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

Classes

class  Pair
 The class Pair. More...
 
class  Pair1D
 The class Pair1D. More...
 
class  Pair1D_angular
 The class Pair1D_angular. More...
 
class  Pair1D_angular_lin
 The class Pair1D_angular_lin. More...
 
class  Pair1D_angular_log
 The class Pair1D_angular_log. More...
 
class  Pair1D_comoving
 The class Pair1D_comoving. More...
 
class  Pair1D_comoving_lin
 The class Pair1D_comoving_lin. More...
 
class  Pair1D_comoving_log
 The class Pair1D_comoving_log. More...
 
class  Pair1D_comoving_multipoles
 The class Pair1D_comoving_multipoles. More...
 
class  Pair1D_comoving_multipoles_lin
 The class Pair1D_comoving_multipoles_lin. More...
 
class  Pair1D_comoving_multipoles_log
 The class Pair1D_comoving_multipoles_log. More...
 
class  Pair1D_extra
 The class Pair1D_extra. More...
 
class  Pair1D_angular_extra
 The class Pair1D_angular_extra. More...
 
class  Pair1D_angular_lin_extra
 The class Pair1D_angular_lin_extra. More...
 
class  Pair1D_angular_log_extra
 The class Pair1D_angular_log_extra. More...
 
class  Pair1D_comoving_extra
 The class Pair1D_comoving_extra. More...
 
class  Pair1D_comoving_lin_extra
 The class Pair1D_comoving_lin_extra. More...
 
class  Pair1D_comoving_log_extra
 The class Pair1D_comoving_log_extra. More...
 
class  Pair1D_comoving_multipoles_extra
 The class Pair1D_comoving_multipoles_extra. More...
 
class  Pair1D_comoving_multipoles_lin_extra
 The class Pair1D_comoving_multipoles_lin_extra. More...
 
class  Pair1D_comoving_multipoles_log_extra
 The class Pair1D_comoving_multipoles_log_extra. More...
 
class  Pair2D
 The class Pair2D. More...
 
class  Pair2D_comovingCartesian
 The class Pair2D_comovingCartesian. More...
 
class  Pair2D_comovingCartesian_linlin
 The class Pair2D_comovingCartesian_linlin. More...
 
class  Pair2D_comovingCartesian_loglin
 The class Pair2D_comovingCartesian_loglin. More...
 
class  Pair2D_comovingCartesian_linlog
 The class Pair2D_comovingCartesian_linlog. More...
 
class  Pair2D_comovingCartesian_loglog
 The class Pair2D_comovingCartesian_loglog. More...
 
class  Pair2D_comovingPolar
 The class Pair2D_comovingPolar. More...
 
class  Pair2D_comovingPolar_linlin
 The class Pair2D_comovingPolar_linlin. More...
 
class  Pair2D_comovingPolar_loglin
 The class Pair2D_comovingPolar_loglin. More...
 
class  Pair2D_comovingPolar_linlog
 The class Pair2D_comovingPolar_linlog. More...
 
class  Pair2D_comovingPolar_loglog
 The class Pair2D_comovingPolar_loglog. More...
 
class  Pair2D_extra
 The class Pair2D_extra. More...
 
class  Pair2D_comovingCartesian_extra
 The class Pair2D_comovingCartesian_extra. More...
 
class  Pair2D_comovingCartesian_linlin_extra
 The class Pair2D_comovingCartesian_linlin_extra. More...
 
class  Pair2D_comovingCartesian_loglin_extra
 The class Pair2D_comovingCartesian_loglin_extra. More...
 
class  Pair2D_comovingCartesian_linlog_extra
 The class Pair2D_comovingCartesian_linlog_extra. More...
 
class  Pair2D_comovingCartesian_loglog_extra
 The class Pair2D_comovingCartesian_loglog_extra. More...
 
class  Pair2D_comovingPolar_extra
 The class Pair2D_comovingPolar_extra. More...
 
class  Pair2D_comovingPolar_linlin_extra
 The class Pair2D_comovingPolar_linlin_extra. More...
 
class  Pair2D_comovingPolar_loglin_extra
 The class Pair2D_comovingPolar_loglin_extra. More...
 
class  Pair2D_comovingPolar_linlog_extra
 The class Pair2D_comovingPolar_linlog_extra. More...
 
class  Pair2D_comovingPolar_loglog_extra
 The class Pair2D_comovingPolar_loglog_extra. More...
 

Enumerations

enum class  PairType {
  _angular_lin_ , _angular_log_ , _comoving_lin_ , _comoving_log_ ,
  _comoving_multipoles_lin_ , _comoving_multipoles_log_ , _comovingCartesian_linlin_ , _comovingCartesian_linlog_ ,
  _comovingCartesian_loglin_ , _comovingCartesian_loglog_ , _comovingPolar_linlin_ , _comovingPolar_linlog_ ,
  _comovingPolar_loglin_ , _comovingPolar_loglog_
}
 the pair type More...
 
enum class  PairInfo { _standard_ , _extra_ }
 the information contained in the pairs More...
 

Functions

std::vector< std::string > PairTypeNames ()
 return a vector containing the PairType names More...
 
std::vector< std::string > PairInfoNames ()
 return a vector containing the PairInfo names More...
 

Detailed Description

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

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

Enumeration Type Documentation

◆ PairInfo

enum cbl::pairs::PairInfo
strong

the information contained in the pairs

Enumerator
_standard_ 

standard: the object contains only the number of pairs

_extra_ 

extra: the object contains the number of pairs plus extra information, such as the mean scale separation and redshift

Definition at line 117 of file Pair.h.

◆ PairType

enum cbl::pairs::PairType
strong

the pair type

Enumerator
_angular_lin_ 

1D pair in angular coordinates in linear bins

_angular_log_ 

1D pair in angular coordinates in logarithmic bins

_comoving_lin_ 

1D pair in comoving coordinates in linear bins

_comoving_log_ 

1D pair in comoving coordinates in logarithmic bins

_comoving_multipoles_lin_ 

1D pair in comoving coordinates in linear bins, multipoles

_comoving_multipoles_log_ 

1D pair in comoving coordinates in logarithmic bins, multipoles

_comovingCartesian_linlin_ 

2D pair in comoving Cartesian coordinates (rp, π) in linear-linear bins

_comovingCartesian_linlog_ 

2D pair in comoving Cartesian coordinates (rp, π) in linear-logarithmic bins

_comovingCartesian_loglin_ 

2D pair in comoving Cartesian coordinates (rp, π) in logarithmic-linear bins

_comovingCartesian_loglog_ 

2D pair in comoving Cartesian coordinates (rp, π) in logarithmic-logarithmic bins

_comovingPolar_linlin_ 

2D pair in comoving polar coordinates (r, μ) in linear-linear bins

_comovingPolar_linlog_ 

2D pair in comoving polar coordinates (r, μ) in linear-logarithmic bins

_comovingPolar_loglin_ 

2D pair in comoving polar coordinates (r, μ) in logarithmic-linear bins

_comovingPolar_loglog_ 

2D pair in comoving polar coordinates (r, μ) in logarithmic-logarithmic bins

Definition at line 59 of file Pair.h.

Function Documentation

◆ PairInfoNames()

std::vector<std::string> cbl::pairs::PairInfoNames ( )
inline

return a vector containing the PairInfo names

Returns
a vector containing the PairInfo names

Definition at line 133 of file Pair.h.

◆ PairTypeNames()

std::vector<std::string> cbl::pairs::PairTypeNames ( )
inline

return a vector containing the PairType names

Returns
a vector containing the PairType names

Definition at line 111 of file Pair.h.