SGRMultiArrayParam Class Reference

MultiArray<double>-parameter. More...

#include <SGParameter.hpp>

Inheritance diagram for SGRMultiArrayParam:

[legend]Collaboration diagram for SGRMultiArrayParam:

[legend]List of all members.

Public Member Functions
	SGRMultiArrayParam (char *name, SGParam *tl, bool hdv=0)
	Constructor.
virtual	~SGRMultiArrayParam ()
	Virtual destructor.
Static Public Attributes
static char	TypeId [] = "MAr"
Protected Member Functions
void	read_param ()
	Reads a value of the parameter from the input stream.
void	print_param (std::ostream &s, short indent)
	Prints the name and the value of the parameter with a given indent.
void	print_group (std::ostream &s, MultiIndex &I, int depth=0)
	Prints a group for a given index.

---

Detailed Description

MultiArray<double>-parameter.

The syntax is similar with that for the small matrices but the depth may be greater or smaller. Thus one can specify the MultiArrays of any dimensionality.

Note:

1. There can be no default value for the array. If the parameter
   has not been specified at all, but the 'default initialization'
   flag is set then the matrix has the zero sizes. The user should
   check this.
2. The constructions like
   <name> [=] [];
   are NOT allowed. At least one entry should be specified.
3. Use the normal MultiArray<double>-member functions to work with
   the parameter.

---

Constructor & Destructor Documentation

SGRMultiArrayParam::SGRMultiArrayParam	(	char *	name,
		SGParam *	tl,
		bool	hdv = 0
	)			[inline]

Constructor.

Parameters:

[in]	name	The name of the parameter
[in]	tl	The next parameter in the list
[in]	hdv	non-zero to suppress the error if not set explicitly

virtual SGRMultiArrayParam::~SGRMultiArrayParam

(

)

[inline, virtual]

Virtual destructor.

---

Member Function Documentation

void SGRMultiArrayParam::read_param

(

)

[protected, virtual]

Reads a value of the parameter from the input stream.

Implements SGParam.

void SGRMultiArrayParam::print_param	(	std::ostream &	s,
		short	indent
	)			[protected, virtual]

Prints the name and the value of the parameter with a given indent.

Parameters:

[in]	s	The stream to print to
[in]	indent	The indent for the output lines

Implements SGParam.

void SGRMultiArrayParam::print_group	(	std::ostream &	s,
		MultiIndex &	I,
		int	depth = 0
	)			[protected]

Prints a group for a given index.

Parameters:

[in]	s	The stream to print to
[in]	I	The multi-index
[in]	depth	The index in the multi-index

---

Member Data Documentation

char SGRMultiArrayParam::TypeId = "MAr" [static]

---

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

• SGParameter.hpp
• SGParameter.cpp

---