lsst::cpputils Namespace Reference

Namespaces
namespace	backtrace
namespace	details
namespace	python
namespace	version

Classes
class	Backtrace
	Singleton, enables automatic backtraces on the following signals: More...
class	Cache
	Cache of most recently used values. More...
struct	key
struct	n
class	Symbol

Functions
std::string	demangleType (std::string const _typeName)
std::size_t	hashCombine (std::size_t seed) noexcept
	Combine hashes.
template<typename T, typename... Rest>
std::size_t	hashCombine (std::size_t seed, const T &value, Rest... rest) noexcept
	Combine hashes.
template<typename InputIterator>
std::size_t	hashIterable (std::size_t seed, InputIterator begin, InputIterator end) noexcept
	Combine hashes in an iterable.
double	nanojanskyToABMagnitude (double flux)
	Convert a flux in nanojansky to AB magnitude.
double	ABMagnitudeToNanojansky (double magnitude)
	Convert an AB magnitude to a flux in nanojansky.
std::string	getPackageDir (std::string const &packageName)
	return the root directory of a setup package
std::string	getPackageDirFromAddress (void const *addressInLibrary)
	return the root directory of the package whose shared library contains the given address
template<typename T>
constexpr void	assertValidHash ()
	Compile-time test of whether a specialization of std::hash conforms to the general spec.
template<typename T>
void	assertHashesEqual (T obj1, T obj2)
	Test that equal objects have equal hashes.

Variables
const double	referenceFlux = 1e23 * pow(10, (48.6 / -2.5)) * 1e9
	The Oke & Gunn (1983) AB magnitude reference flux, in nJy (often approximated as 3631.0).

Function Documentation

ABMagnitudeToNanojansky()

double lsst::cpputils::ABMagnitudeToNanojansky

(

double

magnitude

)

Convert an AB magnitude to a flux in nanojansky.

Definition at line 32 of file Magnitude.cc.

assertHashesEqual()

template<typename T>

void lsst::cpputils::assertHashesEqual	(	T	obj1,
		T	obj2 )

Test that equal objects have equal hashes.

If objects of type T can be equal despite having different internal representations, you should include pairs of such objects.

Template Parameters

T	A hashable type.

Parameters

obj1,obj2

Two equal objects.

Definition at line 102 of file tests.h.

assertValidHash()

template<typename T>

void lsst::cpputils::assertValidHash ( )

constexpr

Compile-time test of whether a specialization of std::hash conforms to the general spec.

The function itself is a no-op.

Template Parameters

T	The properties of std::hash<T> will be tested.

Definition at line 72 of file tests.h.

demangleType()

std::string lsst::cpputils::demangleType

(

std::string const

_typeName

)

Definition at line 113 of file Demangle.cc.

getPackageDir()

std::string lsst::cpputils::getPackageDir

(

std::string const &

packageName

)

return the root directory of a setup package

Parameters

[in]

packageName

name of package (e.g. "utils")

Exceptions

lsst::pex::exceptions::NotFoundError

if desired version can't be found

Definition at line 36 of file packaging.cc.

getPackageDirFromAddress()

std::string lsst::cpputils::getPackageDirFromAddress

(

void const *

addressInLibrary

)

return the root directory of the package whose shared library contains the given address

The address is resolved to its containing shared library via dladdr, and the package root is derived from that library's location (.../lib/libFoo.so -> ...). This allows a package to locate its own data files without relying on environment variables, provided the address belongs to a symbol compiled into that package's own shared library.

Parameters

[in]

addressInLibrary

address of a symbol residing in the target package's shared library

Exceptions

lsst::pex::exceptions::NotFoundError

if the library cannot be located

Definition at line 50 of file packaging.cc.

hashCombine() [1/2]

std::size_t lsst::cpputils::hashCombine ( std::size_t seed )

inlinenoexcept

Combine hashes.

A specialization of hashCombine for a trivial argument list.

Definition at line 35 of file hashCombine.h.

hashCombine() [2/2]

template<typename T, typename... Rest>

std::size_t lsst::cpputils::hashCombine ( std::size_t seed, const T & value, Rest... rest )

noexcept

Combine hashes.

This is provided as a convenience for those who need to hash a composite. C++11 includes std::hash, but neglects to include a facility for combining hashes.

Template Parameters

T,Rest

the types to hash. All types must have a valid (in particular, non-throwing) specialization of std::hash.

Parameters

seed	An arbitrary starting value.
value,rest	The objects to hash.

Returns

A combined hash for all the arguments after seed.

Exception Safety

Shall not throw exceptions.

To use it:

// Arbitrary seed; can change to get different hashes of same argument list
std::size_t seed = 0;
result = hashCombine(seed, obj1, obj2, obj3);

Definition at line 63 of file hashCombine.h.

hashIterable()

template<typename InputIterator>

std::size_t lsst::cpputils::hashIterable ( std::size_t seed, InputIterator begin, InputIterator end )

noexcept

Combine hashes in an iterable.

This is provided as a convenience for those who need to hash a container.

Template Parameters

InputIterator

an iterator to the objects to be hashed. The pointed-to type must have a valid (in particular, non-throwing) specialization of std::hash.

Parameters

seed	An arbitrary starting value.
begin,end	The range to hash.

Returns

A combined hash for all the elements in [begin, end).

Exception Safety

Shall not throw exceptions.

To use it:

// Arbitrary seed; can change to get different hashes of same argument list
std::size_t seed = 0;
result = hashIterable(seed, container.begin(), container.end());

Definition at line 93 of file hashCombine.h.

nanojanskyToABMagnitude()

double lsst::cpputils::nanojanskyToABMagnitude

(

double

flux

)

Convert a flux in nanojansky to AB magnitude.

Definition at line 30 of file Magnitude.cc.

Variable Documentation

referenceFlux

const double lsst::cpputils::referenceFlux = 1e23 * pow(10, (48.6 / -2.5)) * 1e9

The Oke & Gunn (1983) AB magnitude reference flux, in nJy (often approximated as 3631.0).

Definition at line 46 of file Magnitude.h.