apfel::ConvolutionMap Class Reference

The ConvolutionMap class encapsulates the set of rules to multiply a sets of operators with a set of distributions. More...

#include <convolutionmap.h>

Inheritance diagram for apfel::ConvolutionMap:

Classes
struct	rule
	This structure contains the attribute of a single rule. More...

Public Member Functions
	ConvolutionMap (std::string const &name)
	ConvolutionMap constructor.
Setters
void	SetRules (std::map< int, std::vector< rule > > const &rules)
	Set the rule of the convolution map.
Getters
std::string const &	GetName () const
	Retrieve the name of the map.
std::map< int, std::vector< rule > > const &	GetRules () const
	Retrieve the full set of rules for the multiplications.
matrix< std::vector< double > > const	GetRuleMatrix () const
	Retrieve the full set of rules for the multiplications in the form of a matrix.
matrix< std::vector< int > > const	GetRuleIndices () const
	Retrieve the operand indices of the full set of rules for the multiplications in the form of a matrix. Elements set to -1 correspond to empty slots.
void	Print () const
	Print the Operator object.

Protected Attributes
std::map< int, std::vector< rule > >	_rules
	the map container
std::string	_name
	the name of the derived class

Friends
std::ostream &	operator<< (std::ostream &os, ConvolutionMap const &cm)
	Method which prints ConvolutionMap with cout <<.

Detailed Description

The ConvolutionMap class encapsulates the set of rules to multiply a sets of operators with a set of distributions.

Constructor & Destructor Documentation

ConvolutionMap()

apfel::ConvolutionMap::ConvolutionMap

(

std::string const &

name

)

ConvolutionMap constructor.

Parameters

name	name of the map

Member Function Documentation

GetName()

std::string const & apfel::ConvolutionMap::GetName ( ) const

inline

Retrieve the name of the map.

Returns

The name of the map

GetRuleIndices()

matrix< std::vector< int > > const apfel::ConvolutionMap::GetRuleIndices

(

)

const

Retrieve the operand indices of the full set of rules for the multiplications in the form of a matrix. Elements set to -1 correspond to empty slots.

GetRuleMatrix()

matrix< std::vector< double > > const apfel::ConvolutionMap::GetRuleMatrix

(

)

const

Retrieve the full set of rules for the multiplications in the form of a matrix.

GetRules()

std::map< int, std::vector< rule > > const & apfel::ConvolutionMap::GetRules ( ) const

inline

Retrieve the full set of rules for the multiplications.

Returns

The multiplication rules

Print()

void apfel::ConvolutionMap::Print ( ) const

inline

Print the Operator object.

SetRules()

void apfel::ConvolutionMap::SetRules ( std::map< int, std::vector< rule > > const & rules )

inline

Set the rule of the convolution map.

Parameters

rules

the input set of rules

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, ConvolutionMap const & cm )

friend

Method which prints ConvolutionMap with cout <<.

Member Data Documentation

_name

std::string apfel::ConvolutionMap::_name

protected

the name of the derived class

_rules

std::map<int, std::vector<rule> > apfel::ConvolutionMap::_rules

protected

the map container

---

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

• /Users/vb262523/Codes/apfelxx/inc/apfel/convolutionmap.h