IGLib 1.4
The IGLib base library for development of numerical, technical and business applications.

IG::Num::RealFunctionParametricBase Class Reference

Base class for parameterized real-valued functions of single variable. Parameters that completely define the function out of parametric family of functions can be queried or set. More...

Inheritance diagram for IG::Num::RealFunctionParametricBase:
Collaboration diagram for IG::Num::RealFunctionParametricBase:

List of all members.

Public Member Functions

 RealFunctionParametricBase (IVector parameters)
 Cobnstructor. Creates a new parametric real-valued functions of single variable with the specified parameters.
virtual double[] GetParameters ()
 Returns parameters of the current parametric function as an array.
virtual void SetParameters (double[] parameters)
 Sets parameters of the current parametric functions, where parameters are specified as array.
virtual double GetParameter (int which)
 Returns value of the specified parameter of the parameterized function.
virtual void SetParameter (int which, double value)
 Sets the specific parameters of the parameterized function.

Properties

abstract IVector Parameters [get, set]
 Gets or sets parameters that define the specific function out of parametric familiy of functions. Usually a reference is set or returned.
virtual int NumParameters [get]
 Gets number of parameters that define the current function out of parametric family of functions.

Private Member Functions

 RealFunctionParametricBase ()
 Default constructor is inaccessible because it has no meaning.

Detailed Description

Base class for parameterized real-valued functions of single variable. Parameters that completely define the function out of parametric family of functions can be queried or set.

This base class does not implement data containing parameters. This enables to derive base classes with different representations of parameters, e.g. with only one number for one parametric functions. $A Igor Dec10;


Constructor & Destructor Documentation

IG::Num::RealFunctionParametricBase::RealFunctionParametricBase ( ) [inline, private]

Default constructor is inaccessible because it has no meaning.

IG::Num::RealFunctionParametricBase::RealFunctionParametricBase ( IVector  parameters) [inline]

Cobnstructor. Creates a new parametric real-valued functions of single variable with the specified parameters.

Parameters:
parametersVector of parameters that define a specific function out of a parametric family of functions.

Member Function Documentation

virtual double [] IG::Num::RealFunctionParametricBase::GetParameters ( ) [inline, virtual]

Returns parameters of the current parametric function as an array.

Usually, implementations use vector as natural representation of parameters, therefore this function creates an array and copies values.

Implements IG::Num::IRealFunctionParametric.

Reimplemented in IG::Num::RealFunctionOneParametric.

virtual void IG::Num::RealFunctionParametricBase::SetParameters ( double[]  parameters) [inline, virtual]

Sets parameters of the current parametric functions, where parameters are specified as array.

Parameters:
parametersArray of parameters. Array length must correspond to actual number of parameters.

Implements IG::Num::IRealFunctionParametric.

Reimplemented in IG::Num::RealFunctionOneParametric.

virtual double IG::Num::RealFunctionParametricBase::GetParameter ( int  which) [inline, virtual]

Returns value of the specified parameter of the parameterized function.

Parameters:
whichSpecifies which parameter is returned.

Implements IG::Num::IRealFunctionParametric.

Reimplemented in IG::Num::RealFunctionOneParametric.

virtual void IG::Num::RealFunctionParametricBase::SetParameter ( int  which,
double  value 
) [inline, virtual]

Sets the specific parameters of the parameterized function.

Parameters:
whichSpecifies which parameter is set.
valueValue of the specified parameter.

Implements IG::Num::IRealFunctionParametric.

Reimplemented in IG::Num::RealFunctionOneParametric.


Property Documentation

abstract IVector IG::Num::RealFunctionParametricBase::Parameters [get, set]

Gets or sets parameters that define the specific function out of parametric familiy of functions. Usually a reference is set or returned.

Implements IG::Num::IRealFunctionParametric.

Reimplemented in IG::Num::RealFunctionParametric, and IG::Num::RealFunctionOneParametric.

virtual int IG::Num::RealFunctionParametricBase::NumParameters [get]

Gets number of parameters that define the current function out of parametric family of functions.

Implements IG::Num::IRealFunctionParametric.

Reimplemented in IG::Num::RealFunctionOneParametric.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties Events