Input data element definition for vector functions, approximations, etc. More...

Inheritance diagram for IG.Num.InputElementDefinition:

Collaboration diagram for IG.Num.InputElementDefinition:

Public Member Functions
	InputElementDefinition (int elementIndex, string name=null, string title=null, string description=null)
	Constructor. More...

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

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

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

InputElementDefinition	GetCopy ()
	Creates and returns a deep copy of the current input data element definition. More...

override string	ToString ()

Public Member Functions inherited from IG.Num.InputOutputElementDefinition
	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 (InputElementDefinition original, InputElementDefinition copy)
	Copies data from one input data element definition to another. More...

static void	Copy (InputElementDefinition original, ref InputElementDefinition copy)
	Copies data from one input data element definition to another. More...

Static Public Member Functions inherited from IG.Num.InputOutputElementDefinition
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
bool	_defaultValueDefined = false

double	_defaultValue

bool	_optimizationIndexDefined = false

int	_optimizationIndex

double	_discretizationStep = 0.0

int	_numSamplingPoints = 10

Protected Attributes inherited from IG.Num.InputOutputElementDefinition
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 bool	DefaultValueDefined `[get, set]`
	Flag indicating whether default value is defined for the input parameter described by the current eleemnt description. More...

virtual double	DefaultValue `[get, set]`
	Default value for the output data element described by the current definition. More...

virtual bool	OptimizationIndexSpecified `[get, set]`
	Flag indicating whether optimization parameter index is defined for the input parameter described by the current element description. This index tells which optimization parameter corresponds to the current sampled data input parameter. More...

virtual int	OptimizationIndex `[get, set]`
	Optimization parameter index of the data element described by the current definition. This index tells which optimization parameter corresponds to the current sampled data input parameter. More...

virtual double	DiscretizationStep `[get, set]`
	Discretization step that is used in cases where parameter the input parameter has discrete values. Discretization starts at MinValue. More...

virtual int	NumSamplingPoints `[get, set]`
	Number of sampling points along the correspoinding input parameter. More...

Properties inherited from IG.Num.InputOutputElementDefinition
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

Input data element definition for vector functions, approximations, etc.

$A Igor Feb11;

Constructor & Destructor Documentation

IG.Num.InputElementDefinition.InputElementDefinition	(	int	elementIndex,
		string	name = `null`,
		string	title = `null`,
		string	description = `null`
	)

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.InputElementDefinition.InputElementDefinition ( 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.InputElementDefinition.InputElementDefinition	(	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.InputElementDefinition.InputElementDefinition	(	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

InputElementDefinition IG.Num.InputElementDefinition.GetCopy ( )

inline

Creates and returns a deep copy of the current input data element definition.

Returns

References IG.Num.InputElementDefinition.CopyPlain().

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

inlinestatic

Copies data from one input 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.

References IG.Num.InputOutputElementDefinition.CopyPlain(), IG.Num.InputElementDefinition.DefaultValue, IG.Num.InputElementDefinition.DefaultValueDefined, IG.Num.InputElementDefinition.DiscretizationStep, IG.Num.InputElementDefinition.NumSamplingPoints, IG.Num.InputElementDefinition.OptimizationIndex, and IG.Num.InputElementDefinition.OptimizationIndexSpecified.

Referenced by IG.Num.InputElementDefinition.Copy(), and IG.Num.InputElementDefinition.GetCopy().

static void IG.Num.InputElementDefinition.Copy	(	InputElementDefinition	original,
		ref InputElementDefinition	copy
	)

inlinestatic

Copies data from one input data element definition to another.

Parameters

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

If original object is null then destination object is also set to null. If destination object is nul then it is allocated anew.

References IG.Num.InputElementDefinition.CopyPlain(), and IG.Num.InputOutputElementDefinition.Name.

Referenced by IG.Num.InputOutputDataDefiniton.CopyPlain().

override string IG.Num.InputElementDefinition.ToString ( )

inline

Member Data Documentation

bool IG.Num.InputElementDefinition._defaultValueDefined = false

protected

double IG.Num.InputElementDefinition._defaultValue

protected

bool IG.Num.InputElementDefinition._optimizationIndexDefined = false

protected

int IG.Num.InputElementDefinition._optimizationIndex

protected

double IG.Num.InputElementDefinition._discretizationStep = 0.0

protected

int IG.Num.InputElementDefinition._numSamplingPoints = 10

protected

Property Documentation

virtual bool IG.Num.InputElementDefinition.DefaultValueDefined

getset

Flag indicating whether default value is defined for the input parameter described by the current eleemnt description.

Referenced by IG.Forms.InputParametersControl.CopyDataToGrid(), IG.Forms.InpuOrOutputtDataDefinitionControl.CopyDataToGridRow(), IG.Num.InputOutputDataDefiniton.CopyDefaultInputFrom(), IG.Num.InputOutputDataDefiniton.CopyDefaultInputTo(), IG.Num.InputElementDefinitionDto.CopyFromPlain(), IG.Forms.InpuOrOutputtDataDefinitionControl.CopyGridRowToData(), IG.Num.InputElementDefinition.CopyPlain(), IG.Num.InputElementDefinitionDto.CopyToPlain(), IG.Num.VectorFunctionScriptControllerBase< VectorFunctionType, ScalarFunctionControllerType, ScalarFunctionType >.GetDataDefinitionObject(), IG.Num.ScalarFunctionScriptControllerBase< ScalarFunctionType >.GetDataDefinitionObject(), IG.Script.LoadableScriptShellNeuralBase.GetNeuralInputDefault(), IG.Script.LoadableScriptShellNeuralBase.GetSimulationInputDefault(), IG.Num.InputOutputDataDefiniton.IsAnyInputDefaultValueDefined(), IG.Num.SampledDataCsv.ReadElementDefaultValues(), IG.Forms.InputParametersControl.ResetToCenter(), IG.Forms.InputParametersControl.ResetToDefault(), IG.Num.SampledDataCsv.StoreDefinition(), IG.Num.InputOutputDataDefiniton.SupplementDataDefinition(), and IG.Forms.InputParameterSelectorMinMax.UpdateDataDefinition().

virtual double IG.Num.InputElementDefinition.DefaultValue

getset

Default value for the output data element described by the current definition.

Referenced by IG.Forms.InputParametersControl.CopyDataToGrid(), IG.Forms.InpuOrOutputtDataDefinitionControl.CopyDataToGridRow(), IG.Num.InputOutputDataDefiniton.CopyDefaultInputFrom(), IG.Num.InputOutputDataDefiniton.CopyDefaultInputTo(), IG.Num.InputElementDefinitionDto.CopyFromPlain(), IG.Forms.InpuOrOutputtDataDefinitionControl.CopyGridRowToData(), IG.Num.InputElementDefinition.CopyPlain(), IG.Num.InputElementDefinitionDto.CopyToPlain(), IG.Script.LoadableScriptShellNeuralBase.CreateDistortedModelData(), IG.Num.VectorFunctionScriptControllerBase< VectorFunctionType, ScalarFunctionControllerType, ScalarFunctionType >.GetDataDefinitionObject(), IG.Num.ScalarFunctionScriptControllerBase< ScalarFunctionType >.GetDataDefinitionObject(), IG.Script.LoadableScriptShellNeuralBase.GetNeuralInputDefault(), IG.Script.LoadableScriptShellNeuralBase.GetSimulationInputDefault(), IG.Neural.NeuralTadej.LoadDefinitionDataCSV(), IG.Num.SampledDataSet.LoadDefinitionDataCSV(), IG.Num.SampledDataSet.LoadSampledDataCSVinOneLine(), IG.Neural.NeuralTadej.LoadTrainingDataCSVinOneLine(), IG.Neural.DataMapperSimple.MapInput(), IG.Num.SampledDataCsv.ReadElementDefaultValues(), IG.Forms.InputParametersControl.ResetToCenter(), IG.Forms.InputParametersControl.ResetToDefault(), IG.Neural.NeuralTadej.SaveDefinitionDataCSV(), IG.Num.SampledDataSet.SaveDefinitionDataCSV(), IG.Num.SampledDataSet.SaveSampledDataCSVinOneLine(), IG.Neural.NeuralTadej.SaveTrainingDataCSVinOneLine(), IG.Num.SampledDataCsv.StoreDefinition(), IG.Num.InputOutputDataDefiniton.SupplementDataDefinition(), and IG.Forms.InputParameterSelectorMinMax.UpdateDataDefinition().

virtual bool IG.Num.InputElementDefinition.OptimizationIndexSpecified

getset

Flag indicating whether optimization parameter index is defined for the input parameter described by the current element description. This index tells which optimization parameter corresponds to the current sampled data input parameter.

Referenced by IG.Num.InputElementDefinitionDto.CopyFromPlain(), IG.Num.InputElementDefinition.CopyPlain(), IG.Num.InputElementDefinitionDto.CopyToPlain(), IG.Num.InputOutputDataDefiniton.IsAnyInputOptimizationIndexSpecified(), IG.Num.SampledDataCsv.ReadElementOptimizationIndices(), IG.Num.SampledDataCsv.StoreDefinition(), and IG.Num.InputOutputDataDefiniton.SupplementDataDefinition().

virtual int IG.Num.InputElementDefinition.OptimizationIndex

getset

Optimization parameter index of the data element described by the current definition. This index tells which optimization parameter corresponds to the current sampled data input parameter.

Referenced by IG.Num.InputElementDefinitionDto.CopyFromPlain(), IG.Num.InputElementDefinition.CopyPlain(), IG.Num.InputElementDefinitionDto.CopyToPlain(), IG.Num.SampledDataCsv.ReadElementOptimizationIndices(), IG.Num.SampledDataCsv.StoreDefinition(), and IG.Num.InputOutputDataDefiniton.SupplementDataDefinition().

virtual double IG.Num.InputElementDefinition.DiscretizationStep

getset

Discretization step that is used in cases where parameter the input parameter has discrete values. Discretization starts at MinValue.

This field was required by the Jozef Stefan optimization group.

Referenced by IG.Num.InputElementDefinitionDto.CopyFromPlain(), IG.Num.InputElementDefinition.CopyPlain(), IG.Num.InputElementDefinitionDto.CopyToPlain(), IG.Script.LoadableScriptShellNeuralBase.CreateDistortedModelData(), IG.Num.InputOutputDataDefiniton.IsAnyInputDiscretizationStepDefined(), IG.Num.SampledDataCsv.ReadElementDiscretizationSteps(), and IG.Num.SampledDataCsv.StoreDefinition().

virtual int IG.Num.InputElementDefinition.NumSamplingPoints

getset

Number of sampling points along the correspoinding input parameter.

Referenced by IG.Forms.InpuOrOutputtDataDefinitionControl.CopyDataToGridRow(), IG.Num.InputElementDefinitionDto.CopyFromPlain(), IG.Forms.InpuOrOutputtDataDefinitionControl.CopyGridRowToData(), IG.Num.InputElementDefinition.CopyPlain(), IG.Num.InputElementDefinitionDto.CopyToPlain(), IG.Script.LoadableScriptShellNeuralBase.CreateDistortedModelData(), IG.Num.InputOutputDataDefiniton.IsAnyInputNumSamplingPointsDefined(), IG.Num.SampledDataCsv.ReadElementNumSamplingPoints(), and IG.Num.SampledDataCsv.StoreDefinition().

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

igbase/numeric/approximation/sampleddata/SampledDataDefinition.cs

Public Member Functions

Static Public Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation