Base class for input or output data element definition for vector functions, approximations, etc. More...

Inheritance diagram for IG.Num.InputOutputElementDefinition:

Public Member Functions
	InputOutputElementDefinition (int elementIndex, string name, string title, string description)
	Constructor. More...

	InputOutputElementDefinition (string name)
	Constructor. Element index is unknown, there is no element description. More...

	InputOutputElementDefinition (string name, string title)
	Constructor. Element index is unknown. More...

	InputOutputElementDefinition (string name, string title, string description)
	Constructor. Element index is unknown. More...

void	GetDistortedBounds (double DistortionFactor, double RandomFactor, ref double distortedMinimalValue, ref double distrotedMaximalValue)
	Calculates randomly distorted bounds on element values and stores them in the specified variables. More...

void	GetDistortedBounds (double DistortionFactor, double RandomFactor, ref double distortedMinimalValue, ref double distrotedMaximalValue, IRandomGenerator randomGenerator)
	Calculates randomly distorted bounds on element values and stores them in the specified variables. More...

override string	ToString ()

Static Public Member Functions
static void	CopyPlain (InputOutputElementDefinition original, InputOutputElementDefinition copy)
	Copies data from one input/output data element definition to another. More...

static string	GetDefaultInputElementName (int which)
	Returns a default name for the specified input data element. More...

static string	GetDefaultOutputElementName (int which)
	Returns a default name for the specified output data element. More...

static string	GetDefaultInputElementTitle (int which)
	Returns a default title for the specified input data element. More...

static string	GetDefaultOutputElementTitle (int which)
	Returns a default title for the specified output data element. More...

static string	GetDefaultInputElementDescription (int which)
	Returns a default description for the specified input data element. More...

static string	GetDefaultOutputElementDescription (int which)
	Returns a default description for the specified output data element. More...

Protected Attributes
string	_name

string	_nameAlt

string	_title

string	_description

bool	_isInput = true

bool	_elementindexSpecified = false

int	_elementIndex = -1

bool	_boundsDefined = false

double	_minValue

double	_maxValue

bool	_targetValueDefined = false

double	_targetValue = 0.0

bool	_scalingLengthDefined = false

double	_scalingLength = 0.0

Properties
virtual string	Name `[get, set]`
	Unique name of the data element described by the current definition. Considered a kind of variable name that distinguishes between data by short names. More...

virtual string	NameAlt `[get, set]`
	Alternative name of the data element described by the current definition. More...

virtual string	Title `[get, set]`
	A title describing what given data element represents. Titles can contain special characters and spaces, but should be shorter than descriptions. More...

virtual string	Description `[get, set]`
	Describes the meaning of a data element used as part of input or output data. More...

virtual bool	IsInput `[get, set]`
	Flag specifying whether a data element is input or output element. More...

virtual bool	ElementIndexSpecified `[get, set]`
	Specifies whether element index is specified for the data element described by the current definition. More...

virtual int	ElementIndex `[get, set]`
	Specifies the index f the element described by the current definition, within the data vextor (either input or output). More...

virtual bool	BoundsDefined `[get, set]`
	Flag indicating whethe minimal and maximal value are defined for the data element described by the current definition. More...

virtual double	MinimalValue `[get, set]`
	Minimal value for the data element described by the current definition. More...

virtual double	MaximalValue `[get, set]`
	Maximal value for the data element described by the current definition. More...

virtual bool	TargetValueDefined `[get, set]`
	Flag indicating whether target value is defined for the data element described by the current definition. More...

virtual double	TargetValue `[get, set]`
	Target value of the current element. Used for optimization. More...

virtual bool	ScalingLengthDefined `[get, set]`
	Flag indicating whether scaling length is defined for the data element described by the current definition. More...

virtual double	ScalingLength `[get, set]`
	Scaling length, used for optimization and other tasks where scaling of input or output quantities is important. More...

Detailed Description

Base class for input or output data element definition for vector functions, approximations, etc.

$A Igor Feb11;

Constructor & Destructor Documentation

IG.Num.InputOutputElementDefinition.InputOutputElementDefinition	(	int	elementIndex,
		string	name,
		string	title,
		string	description
	)

inline

Constructor.

Parameters

elementIndex	Index of the input or output data element specified by the current definision. If less than 0 is specified then it is considered that element index is not known or defined in the current context.
name	Element name. Should comply with conventions for valid variable names in languages C++, C# and Java.
title	Short descriptive title (like name, but can contain spaces and special characters).
description	Element description. Can be an arbvitrary string.

IG.Num.InputOutputElementDefinition.InputOutputElementDefinition ( string name )

inline

Constructor. Element index is unknown, there is no element description.

Parameters

name	Element name. Should comply with conventions for valid variable names in languages C++, C# and Java.

IG.Num.InputOutputElementDefinition.InputOutputElementDefinition	(	string	name,
		string	title
	)

inline

Constructor. Element index is unknown.

Parameters

name	Element name. Should comply with conventions for valid variable names in languages C++, C# and Java.
title	Short descriptive title (like name, but can contain spaces and special characters).

IG.Num.InputOutputElementDefinition.InputOutputElementDefinition	(	string	name,
		string	title,
		string	description
	)

inline

Constructor. Element index is unknown.

Parameters

name	Element name. Should comply with conventions for valid variable names in languages C++, C# and Java.
title	Short descriptive title (like name, but can contain spaces and special characters).
description	Element description. Can be an arbitrary string.

Member Function Documentation

static void IG.Num.InputOutputElementDefinition.CopyPlain	(	InputOutputElementDefinition	original,
		InputOutputElementDefinition	copy
	)

inlinestatic

Copies data from one input/output data element definition to another.

Parameters

original	Source object that data is copied from.
copy	Object to which data is copied.

Operation is performed only if both sorce and destination objects are non-null.

Referenced by IG.Num.InputElementDefinition.CopyPlain(), and IG.Num.OutputElementDefinition.CopyPlain().

void IG.Num.InputOutputElementDefinition.GetDistortedBounds	(	double	DistortionFactor,
		double	RandomFactor,
		ref double	distortedMinimalValue,
		ref double	distrotedMaximalValue
	)

inline

Calculates randomly distorted bounds on element values and stores them in the specified variables.

Before being randomly changed, input bounds are multiplied by the specified factor.

Global random generator is used to generate random componenets of the distorted bounds.

Parameters

DistortionFactor	Factor by which interval bounds are multiplied before randomly distorted.
RandomFactor	Factor that specifies level of randomness, from 0 (no randomness in setting distorted bounds) to 0.4 inclusively. Factor 0.5 would mean that amplitude of additional random distortion is half of the length of the interval [min, max].
distortedMinimalValue	Variable where distorted lower bound is stored.
distrotedMaximalValue	Variable where distorted upper bound is stored.

Referenced by IG.Script.LoadableScriptShellNeuralBase.CreateDistortedModelData().

void IG.Num.InputOutputElementDefinition.GetDistortedBounds	(	double	DistortionFactor,
		double	RandomFactor,
		ref double	distortedMinimalValue,
		ref double	distrotedMaximalValue,
		IRandomGenerator	randomGenerator
	)

inline

Calculates randomly distorted bounds on element values and stores them in the specified variables.

Before being randomly changed, input bounds are multiplied by the specified factor.

Parameters

DistortionFactor	Factor by which interval bounds are multiplied before randomly distorted.
RandomFactor	Factor that specifies level of randomness, from 0 (no randomness in setting distorted bounds) to 0.4 inclusively. Factor 0.5 would mean that amplitude of additional random distortion is half of the length of the interval [min, max].
distortedMinimalValue	Variable where distorted lower bound is stored.
distrotedMaximalValue	Variable where distorted upper bound is stored.
randomGenerator	Random generator used to randomly generate distorted bounds.

References IG.Num.RandomGenerator.Global, IG.Num.IRandomGenerator.NextDouble(), and IG.Num.M.Swap().

static string IG.Num.InputOutputElementDefinition.GetDefaultInputElementName ( int which )

inlinestatic

Returns a default name for the specified input data element.

Parameters