SGRMatrixParam Class Reference

Small double-matrix parameter. More...

#include <SGParameter.hpp>

Inheritance diagram for SGRMatrixParam:

[legend]Collaboration diagram for SGRMatrixParam:

[legend]List of all members.

Public Member Functions
	SGRMatrixParam (char *name, SGParam *tl, bool hdv=0)
	Constructor.
virtual	~SGRMatrixParam ()
	Virtual destructor.
Static Public Attributes
static char	TypeId [] = "Mr"
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.

---

Detailed Description

Small double-matrix parameter.

Syntax:
<name> [=] [[<r_11>, ..., <r_1n>], ..., [r_m1, ..., r_mn]];
The sizes m and n of the matrix are not predefined and are specified in the input file by the number of the entries in the rows as well as by the number of the rows. The number of the entries should be equal in all the rows.

Note:

1. There can be no default value for the matrix. 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 small_matrix<double>-operations to work with
   the parameter.

---

Constructor & Destructor Documentation

SGRMatrixParam::SGRMatrixParam	(	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 SGRMatrixParam::~SGRMatrixParam

(

)

[inline, virtual]

Virtual destructor.

---

Member Function Documentation

void SGRMatrixParam::read_param

(

)

[protected, virtual]

Reads a value of the parameter from the input stream.

Implements SGParam.

void SGRMatrixParam::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.

---

Member Data Documentation

char SGRMatrixParam::TypeId = "Mr" [static]

---

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

• SGParameter.hpp
• SGParameter.cpp

---