Parameters Class Reference

Parameters class stores Parameter objects. It is a bidirectional map implemented from Boost so that it provides fast translation from and to its underlying Time object. More...

#include <Parameters.h>

Inheritance diagram for Parameters:

Public Member Functions
	Parameters ()=default
virtual	~Parameters ()=default
void	push_back (const Parameter &)
std::size_t	getIndex (const Parameter &) const
void	getIndices (const Parameters &, std::vector< std::size_t > &) const
const Parameter &	getParameter (std::size_t index) const
void	getCirculars (std::vector< bool > &circulars) const
void	getNames (std::vector< std::string > &names) const
void	print (std::ostream &) const

Friends
std::ostream &	operator<< (std::ostream &, Parameters const &)

Detailed Description

Parameters class stores Parameter objects. It is a bidirectional map implemented from Boost so that it provides fast translation from and to its underlying Time object.

Parameters class support the following features:

1. Parameter is unique.
2. Parameter objects are kept in sequence of insertion and have random access.
3. Index of a Parameter object can be quickly retrieved using Parameter.

Constructor & Destructor Documentation

Parameters()

Parameters::Parameters ( )

default

~Parameters()

virtual Parameters::~Parameters ( )

virtualdefault

Member Function Documentation

getCirculars()

void Parameters::getCirculars

(

std::vector< bool > &

circulars

)

const

getIndex()

size_t Parameters::getIndex

(

const Parameter &

parameter

)

const

getIndices()

void Parameters::getIndices	(	const Parameters &	,
		std::vector< std::size_t > &
	)		const

getNames()

void Parameters::getNames

(

std::vector< std::string > &

names

)

const

getParameter()

const Parameter & Parameters::getParameter

(

std::size_t

index

)

const

print()

void Parameters::print

(

std::ostream &

)

const

push_back()

void Parameters::push_back

(

const Parameter &

parameter

)

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  , Parameters const &    )

friend

---

The documentation for this class was generated from the following files:

• /Users/weiming/github/AnalogsEnsemble/CAnEn/include/Parameters.h
• /Users/weiming/github/AnalogsEnsemble/CAnEn/src/Parameters.cpp