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

IG::Num::IRealFunctionParametric Interface Reference

Parameterized real-valued functions of single variable. More...

Inheritance diagram for IG::Num::IRealFunctionParametric:
Collaboration diagram for IG::Num::IRealFunctionParametric:

List of all members.

Public Member Functions

double[] GetParameters ()
 Returns parameters of the current parametric function as an array.
void SetParameters (double[] parameters)
 Sets parameters of the current parametric functions, where parameters are specified as array.
double GetParameter (int which)
 Returns value of the specified parameter of the parameterized function.
void SetParameter (int which, double value)
 Sets the specific parameters of the parameterized function.

Properties

IVector Parameters [get, set]
 Parameters that define the specific function out of parametric familiy of functions.
int NumParameters [get]
 Gets number of parameters that define the specific function out of parametric family of functions.

Detailed Description

Parameterized real-valued functions of single variable.

$A Igor Dec10;


Member Function Documentation

double [] IG::Num::IRealFunctionParametric::GetParameters ( )

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.

Implemented in IG::Num::RealFunctionOneParametric, and IG::Num::RealFunctionParametricBase.

void IG::Num::IRealFunctionParametric::SetParameters ( double[]  parameters)

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.

Implemented in IG::Num::RealFunctionOneParametric, and IG::Num::RealFunctionParametricBase.

double IG::Num::IRealFunctionParametric::GetParameter ( int  which)

Returns value of the specified parameter of the parameterized function.

Parameters:
whichSpecifies which parameter is returned.

Implemented in IG::Num::RealFunctionOneParametric, and IG::Num::RealFunctionParametricBase.

void IG::Num::IRealFunctionParametric::SetParameter ( int  which,
double  value 
)

Sets the specific parameters of the parameterized function.

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

Implemented in IG::Num::RealFunctionOneParametric, and IG::Num::RealFunctionParametricBase.


Property Documentation

IVector IG::Num::IRealFunctionParametric::Parameters [get, set]

Parameters that define the specific function out of parametric familiy of functions.

Implemented in IG::Num::RealFunctionParametric, IG::Num::RealFunctionOneParametric, and IG::Num::RealFunctionParametricBase.

int IG::Num::IRealFunctionParametric::NumParameters [get]

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

Implemented in IG::Num::RealFunctionOneParametric, and IG::Num::RealFunctionParametricBase.


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