#include <Counter.hh>

Inheritance diagram for CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >:

Detailed Description

template<typename _Container, typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>
class CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >

A Counter allows looping over many incrementing variables in one loop.

Template Parameters

Container	The type of container containing the variables begin looped over. Container should be fully specified, so 'std::vector<int>', not 'std::vector'.
value_type	The type of variable contained by the Container. Must have valid operators '+=' and '+'.
size_type	The type of the index into the Container.
Access	A Functor or function with signature 'value_type& Access::operator()(Container &, size_type);', which provides a reference to a element of the Container.
Compare	A Functor or function with signature 'bool Compare::operator()(const value_type& A, const value_type& B);', which provides a less than comparison, like 'operator<'.

Default container access using the CASM_TMP::BracketAccess functor is identical to 'container[index]'. Parentheses access, like 'container(index)', can be obtained by setting the Access parameter using the CASM_TMP::ParenthesesAccess functor.

Default value_type comparison is as 'value_type < value_type'. Custom comparison can be provided using the Compare functor.

Several typedefs are provided:

for Eigen::VectorXd: EigenVectorXdCounter
for Eigen::VectorXi: EigenVectorXiCounter
for Eigen::MatrixXd: EigenMatrixXdCounter
for Eigen::MatrixXi: EigenMatrixXiCounter

The first element of the container is the inner loop, and the last element of the container is the outer loop.

Example:

int size = 3;
std::vector<int> initial(size, 0);
std::vector<int> final(size, 1);
std::vector<int> increment(size, 1);
 
casm::Counter<std::vector<int> > counter(initial, final, increment);
 
do {
  for( int i=0; i<counter.size(); i++) {
    std::cout << counter()[i] << " ";
  }
  std::cout << std::endl;
} while(counter++);

Output:

Definition at line 107 of file Counter.hh.

Public Types
typedef _Container	Container

typedef _value_type	value_type

typedef _size_type	size_type

typedef _Access	Access

typedef _Compare	Compare

typedef CounterValueIterator< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >	const_value_iterator

Public Member Functions
	Counter ()
	Default construct a Counter. More...

	Counter (const Container &_initial, const Container &_final, const Container &_increment, Access _access=Access(), Compare _compare=Compare())
	Construct a Counter-type object. More...

Counter &	operator++ ()

void	operator++ (int)

void	set_current (const Container &new_current)

void	reset ()
	Reset the current value of the Counter to the initial value. More...

bool	valid () const

	operator bool () const

	operator const Container & () const

const value_type &	operator[] (size_type index) const

size_type	size () const

const_value_iterator	value_begin () const

const_value_iterator	value_end () const

bool	compare (const value_type &A, const value_type &B)

const Container &	current () const

const value_type &	current (size_type index) const

const Container &	operator() () const

const Container &	initial () const

const Container &	final () const

const Container &	increment () const

Protected Member Functions
bool &	_valid ()
	non-const reference bool validity flag More...

const value_type &	_current (size_type index) const

value_type &	_current (size_type index)

Container &	_current ()

const value_type &	_initial (size_type index) const

value_type &	_initial (size_type index)

const value_type &	_final (size_type index) const

value_type &	_final (size_type index)

const value_type &	_increment (size_type index) const

value_type &	_increment (size_type index)

const value_type &	_upper (size_type index) const

value_type &	_upper (size_type index)

const value_type &	_lower (size_type index) const

value_type &	_lower (size_type index)

Private Types
typedef traits< Counter >::Base	Base

Private Member Functions
void	_init ()
	Called from the constructor to set m_lower and m_upper appropriately. More...

bool	_compute_validity ()

Private Attributes
Access	m_access

Compare	m_compare
	A functor that enables custom comparison, by default: operator<. More...

Container	m_initial
	Initial container values. More...

Container	m_final
	Final container values. More...

Container	m_increment
	Amount to increment each container value. More...

Container	m_lower
	The minimum of each value of m_initial and m_final. More...

Container	m_upper
	The maximum of each value of m_initial and m_final. More...

Container	m_current
	The current state of the container. More...

bool	m_valid

Member Typedef Documentation

◆ Access

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

typedef _Access CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::Access

Definition at line 123 of file Counter.hh.

◆ Base

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

typedef traits<Counter>::Base CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::Base

private

Definition at line 110 of file Counter.hh.

◆ Compare

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

typedef _Compare CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::Compare

Definition at line 124 of file Counter.hh.

◆ const_value_iterator

typedef CounterValueIterator<Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > > CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::const_value_iterator

inherited

Definition at line 132 of file BaseCounter.hh.

◆ Container

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

typedef _Container CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::Container

Definition at line 120 of file Counter.hh.

◆ size_type

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

typedef _size_type CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::size_type

Definition at line 122 of file Counter.hh.

◆ value_type

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

typedef _value_type CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::value_type

Definition at line 121 of file Counter.hh.

Constructor & Destructor Documentation

◆ Counter() [1/2]

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::Counter ( )

inline

Default construct a Counter.

Definition at line 136 of file Counter.hh.

◆ Counter() [2/2]

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::Counter	(	const Container &	_initial,
		const Container &	_final,
		const Container &	_increment,
		Access	_access = `Access()`,
		Compare	_compare = `Compare()`
	)

inline

Construct a Counter-type object.

Parameters

_initial	the initial Container values
_final	the final valid Container values
_increment	the amount to increment each Container value by

Definition at line 143 of file Counter.hh.

Member Function Documentation

◆ _compute_validity()

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

bool CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::_compute_validity ( )

inlineprivate

Definition at line 204 of file Counter.hh.

◆ _current() [1/3]

Container& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_current ( )

inlineprotectedinherited

non-const Access the current value of the Container

Returns: a non-const reference to the current value of the Container

Definition at line 259 of file BaseCounter.hh.

◆ _current() [2/3]

value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_current ( size_type index )

inlineprotectedinherited

non-const Access to element in the current value of the Container

Returns: a non-const reference to the element 'index' in the current value of the Container

Definition at line 253 of file BaseCounter.hh.

◆ _current() [3/3]

const value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_current ( size_type index ) const

inlineprotectedinherited

const Access to element in the current value of the Container

Returns: a const reference to the element 'index' in the current value of the Container

Definition at line 244 of file BaseCounter.hh.

◆ _final() [1/2]

value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_final ( size_type index )

inlineprotectedinherited

non-const Access to element in the final value of the Container

Returns: a non-const reference to the element 'index' in the final value of the Container

Definition at line 291 of file BaseCounter.hh.

◆ _final() [2/2]

const value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_final ( size_type index ) const

inlineprotectedinherited

const Access to element in the final value of the Container

Returns: a const reference to the element 'index' in the final value of the Container

Definition at line 282 of file BaseCounter.hh.

◆ _increment() [1/2]

value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_increment ( size_type index )

inlineprotectedinherited

non-const Access to element in the increment value of the Container

Returns: a non-const reference to the element 'index' in the increment value of the Container

Definition at line 307 of file BaseCounter.hh.

◆ _increment() [2/2]

const value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_increment ( size_type index ) const

inlineprotectedinherited

const Access to element in the increment value of the Container

Returns: a const reference to the element 'index' in the increment value of the Container

Definition at line 298 of file BaseCounter.hh.

◆ _init()

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

void CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::_init ( )

inlineprivate

Called from the constructor to set m_lower and m_upper appropriately.

Definition at line 192 of file Counter.hh.

◆ _initial() [1/2]

value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_initial ( size_type index )

inlineprotectedinherited

non-const Access to element in the initial value of the Container

Returns: a non-const reference to the element 'index' in the initial value of the Container

Definition at line 275 of file BaseCounter.hh.

◆ _initial() [2/2]

const value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_initial ( size_type index ) const

inlineprotectedinherited

const Access to element in the initial value of the Container

Returns: a const reference to the element 'index' in the initial value of the Container

Definition at line 266 of file BaseCounter.hh.

◆ _lower() [1/2]

value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_lower ( size_type index )

inlineprotectedinherited

non-const Access to element in the lower value of the Container

Returns: a non-const reference to the element 'index' in the lower value of the Container

Definition at line 341 of file BaseCounter.hh.

◆ _lower() [2/2]

const value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_lower ( size_type index ) const

inlineprotectedinherited

const Access to element in the lower value of the Container

Returns: a const reference to the element 'index' in the lower value of the Container

Definition at line 332 of file BaseCounter.hh.

◆ _upper() [1/2]

value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_upper ( size_type index )

inlineprotectedinherited

non-const Access to element in the upper value of the Container

Returns: a non-const reference to the element 'index' in the upper value of the Container

Definition at line 325 of file BaseCounter.hh.

◆ _upper() [2/2]

const value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_upper ( size_type index ) const

inlineprotectedinherited

const Access to element in the upper value of the Container

Returns: a const reference to the element 'index' in the upper value of the Container

Definition at line 316 of file BaseCounter.hh.

◆ _valid()

bool& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::_valid ( )

inlineprotectedinherited

non-const reference bool validity flag

Definition at line 237 of file BaseCounter.hh.

◆ compare()

bool CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::compare	(	const value_type &	A,
		const value_type &	B
	)

inlineinherited

Use internal Compare object to compare two values

Returns: bool that is result of Compare()(value A, value B)

Definition at line 193 of file BaseCounter.hh.

◆ current() [1/2]

const Container& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::current ( ) const

inlineinherited

const Access the current value of the Container

Returns: a const reference to the current value of the Container

Definition at line 201 of file BaseCounter.hh.

◆ current() [2/2]

const value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::current ( size_type index ) const

inlineinherited

const Access the element 'index' of the current value of the Container

Returns: a const reference to an element of the Container

Definition at line 207 of file BaseCounter.hh.

◆ final()

const Container& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::final ( ) const

inlineinherited

const Access the final value of the Container

Returns: a const reference to the final value of the Container

Definition at line 227 of file BaseCounter.hh.

◆ increment()

const Container& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::increment ( ) const

inlineinherited

const Access the incrementing values of the Container

Returns: a const reference to the incrementing value of the Container

Definition at line 233 of file BaseCounter.hh.

◆ initial()

const Container& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::initial ( ) const

inlineinherited

const Access the intial value of the Container

Returns: a const reference to the initial value of the Container

Definition at line 221 of file BaseCounter.hh.

◆ operator bool()

CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::operator bool ( ) const

inlineinherited

Definition at line 162 of file BaseCounter.hh.

◆ operator const Container &()

CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::operator const Container & ( ) const

inlineinherited

const Access the current value of the Container (identical to current)

Returns: a const reference to the current value of the Container

Definition at line 168 of file BaseCounter.hh.

◆ operator()()

const Container& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::operator() ( ) const

inlineinherited

const Access the current value of the Container (identical to current)

Returns: a const reference to the current value of the Container

Definition at line 215 of file BaseCounter.hh.

◆ operator++() [1/2]

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

Counter& CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::operator++ ( )

inline

Increment the Counter

Returns: true if the Counter is in a valid state after incrementing

Definition at line 154 of file Counter.hh.

◆ operator++() [2/2]

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

void CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::operator++ ( int )

inline

Definition at line 170 of file Counter.hh.

◆ operator[]()

const value_type& CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::operator[] ( size_type index ) const

inlineinherited

Definition at line 170 of file BaseCounter.hh.

◆ reset()

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

void CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::reset ( )

inline

Reset the current value of the Counter to the initial value.

Definition at line 184 of file Counter.hh.

◆ set_current()

template<typename _Container , typename _value_type = typename _Container::value_type, typename _size_type = typename _Container::size_type, typename _Access = CASM_TMP::BracketAccess<_Container, _value_type, _size_type>, typename _Compare = CASM_TMP::MuchLessThan<_value_type>>

void CASM::Counter< _Container, _value_type, _size_type, _Access, _Compare >::set_current ( const Container & new_current )

inline

Definition at line 172 of file Counter.hh.

◆ size()

size_type CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::size ( ) const

inlineinherited

Return the size of the Container

Returns: the size of the Container

Definition at line 178 of file BaseCounter.hh.

◆ valid()

bool CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::valid ( ) const

inlineinherited

Returns: false if the Counter::current value has been incremented past the Counter::final

Definition at line 160 of file BaseCounter.hh.

◆ value_begin()

const_value_iterator CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::value_begin ( ) const

inlineinherited

Definition at line 180 of file BaseCounter.hh.

◆ value_end()

const_value_iterator CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::value_end ( ) const

inlineinherited

Definition at line 184 of file BaseCounter.hh.

Member Data Documentation

◆ m_access

Access CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::m_access

privateinherited

A functor that enables different ways of accessing the container, by default: container[index]

Definition at line 346 of file BaseCounter.hh.

◆ m_compare

Compare CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::m_compare

privateinherited

A functor that enables custom comparison, by default: operator<.

Definition at line 349 of file BaseCounter.hh.

◆ m_current

Container CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::m_current

privateinherited

The current state of the container.

Definition at line 367 of file BaseCounter.hh.

◆ m_final

Container CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::m_final

privateinherited

Final container values.

Definition at line 355 of file BaseCounter.hh.

◆ m_increment

Container CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::m_increment

privateinherited

Amount to increment each container value.

Definition at line 358 of file BaseCounter.hh.

◆ m_initial

Container CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::m_initial

privateinherited

Initial container values.

Definition at line 352 of file BaseCounter.hh.

◆ m_lower

Container CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::m_lower

privateinherited

The minimum of each value of m_initial and m_final.

Definition at line 361 of file BaseCounter.hh.

◆ m_upper

Container CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::m_upper

privateinherited

The maximum of each value of m_initial and m_final.

Definition at line 364 of file BaseCounter.hh.

◆ m_valid

bool CASM::BaseCounter< Counter< _Container, typename _Container::value_type, typename _Container::size_type, CASM_TMP::BracketAccess< _Container, typename _Container::value_type, typename _Container::size_type >, CASM_TMP::MuchLessThan< typename _Container::value_type > > >::m_valid

privateinherited

True if m_current is within the allowed bounds, false once all values have been incremented to their limit

Definition at line 371 of file BaseCounter.hh.

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

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/container/Counter.hh

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ Access

◆ Base

◆ Compare

◆ const_value_iterator

◆ Container

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ Counter() [1/2]

◆ Counter() [2/2]

Member Function Documentation

◆ _compute_validity()

◆ _current() [1/3]

◆ _current() [2/3]

◆ _current() [3/3]

◆ _final() [1/2]

◆ _final() [2/2]

◆ _increment() [1/2]

◆ _increment() [2/2]

◆ _init()

◆ _initial() [1/2]

◆ _initial() [2/2]

◆ _lower() [1/2]

◆ _lower() [2/2]

◆ _upper() [1/2]

◆ _upper() [2/2]

◆ _valid()

◆ compare()

◆ current() [1/2]

◆ current() [2/2]

◆ final()

◆ increment()

◆ initial()

◆ operator bool()

◆ operator const Container &()

◆ operator()()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator[]()

◆ reset()

◆ set_current()

◆ size()

◆ valid()

◆ value_begin()

◆ value_end()

Member Data Documentation

◆ m_access

◆ m_compare

◆ m_current

◆ m_final

◆ m_increment

◆ m_initial

◆ m_lower

◆ m_upper

◆ m_valid