boca::GradedContainer< Container_, Value_ > Class Template Reference

Container with associated scalar. More...

#include <GradedContainer.hh>

Inheritance diagram for boca::GradedContainer< Container_, Value_ >:

Collaboration diagram for boca::GradedContainer< Container_, Value_ >:

Public Member Functions
Constructor
	GradedContainer ()
	Default Constructor. More...
	GradedContainer (Container_< Value_ > const &container, Value_ scalar)
	Constructor accepting a Container and a Scalar. More...
Setter
void	Set (Container_< Value_ > const &container, Value_ scalar)
	Set Container and Scalar. More...
void	Set (Container_< Value_ > const &container)
	Set Container. More...
void	Set (Value_ scalar)
	Set Scalar. More...
Accessor and Getter
Container_< Value_ > const &	Container () const
	Getter for Container. More...
Container_< Value_ > &	Container ()
	Accessor of Container. More...
Value_ const &	Scalar () const
	Getter for Scalar. More...
Value_ &	Scalar ()
	Accessor for Scalar. More...
Products and Quotients
auto	Product () const
	Product. More...
Container_< double >	Normalize () const
	Quotient. More...

Operator
bool	operator< (GradedContainer const &graded_container) const
	Less than comparison. More...
bool	operator== (GradedContainer const &graded_container) const
	Equallity comparison. More...
auto &	operator<< (std::ostream &stream, GradedContainer const &graded_container)
	Output stream operator. More...

Detailed Description

template<template< typename > class Container_, typename Value_>
class boca::GradedContainer< Container_, Value_ >

Container with associated scalar.

Constructor & Destructor Documentation

template<template< typename > class Container_, typename Value_ >

boca::GradedContainer< Container_, Value_ >::GradedContainer ( )

inline

Default Constructor.

template<template< typename > class Container_, typename Value_ >

boca::GradedContainer< Container_, Value_ >::GradedContainer ( Container_< Value_ > const &  container, Value_  scalar  )

inline

Constructor accepting a Container and a Scalar.

Member Function Documentation

template<template< typename > class Container_, typename Value_ >

Container_<Value_> const& boca::GradedContainer< Container_, Value_ >::Container ( ) const

inline

Getter for Container.

template<template< typename > class Container_, typename Value_ >

Container_<Value_>& boca::GradedContainer< Container_, Value_ >::Container ( )

inline

Accessor of Container.

template<template< typename > class Container_, typename Value_ >

Container_<double> boca::GradedContainer< Container_, Value_ >::Normalize ( ) const

inline

Quotient.

template<template< typename > class Container_, typename Value_ >

bool boca::GradedContainer< Container_, Value_ >::operator< ( GradedContainer< Container_, Value_ > const &  graded_container ) const

inline

Less than comparison.

template<template< typename > class Container_, typename Value_ >

bool boca::GradedContainer< Container_, Value_ >::operator== ( GradedContainer< Container_, Value_ > const &  graded_container ) const

inline

Equallity comparison.

template<template< typename > class Container_, typename Value_ >

auto boca::GradedContainer< Container_, Value_ >::Product ( ) const

inline

Product.

template<template< typename > class Container_, typename Value_ >

Value_ const& boca::GradedContainer< Container_, Value_ >::Scalar ( ) const

inline

Getter for Scalar.

template<template< typename > class Container_, typename Value_ >

Value_& boca::GradedContainer< Container_, Value_ >::Scalar ( )

inline

Accessor for Scalar.

template<template< typename > class Container_, typename Value_ >

void boca::GradedContainer< Container_, Value_ >::Set ( Container_< Value_ > const &  container, Value_  scalar  )

inline

Set Container and Scalar.

template<template< typename > class Container_, typename Value_ >

void boca::GradedContainer< Container_, Value_ >::Set ( Container_< Value_ > const &  container )

inline

Set Container.

template<template< typename > class Container_, typename Value_ >

void boca::GradedContainer< Container_, Value_ >::Set ( Value_  scalar )

inline

Set Scalar.

Friends And Related Function Documentation

template<template< typename > class Container_, typename Value_ >

auto& operator<< ( std::ostream &  stream, GradedContainer< Container_, Value_ > const &  graded_container  )

friend

Output stream operator.

---

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

• boca/math/GradedContainer.hh