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

- Main Page
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Public Member Functions | Protected Member Functions | Properties | List of all members
IG.Script.LoadableScriptShellNeural Class Reference

Base class for loadable scripts that are used as custom applications that inclued neural networks approximations and optimization. More...

Inheritance diagram for IG.Script.LoadableScriptShellNeural:
[legend]
Collaboration diagram for IG.Script.LoadableScriptShellNeural:
[legend]

## Classes
class | StoredScriptSettings
| In methods of this class you will find all the settings that apply to this script. More...

## Public Member Functions
| LoadableScriptShellNeural ()
override void | Analyse (Num.IAnalysisResults anRes)
| Dummy analysis, jsut throws the exception. More...
override void | TransfSimulationToNeuralInput (IVector original, ref IVector result)
| Transforms the specified vector of simulation input parameters to the vector of neural input parameters and stores the vector to the specified variable. More...
override void | TransfNeuralToSimulationInput (IVector original, ref IVector result)
| Transforms the specified vector of neural input parameters to the vector of simulation input parameters and stores the vector to the specified variable. More...
override void | TransfSimulationToNeuralOutput (IVector original, ref IVector result)
| Transforms the specified vector of simulation output values (results) to the vector of neural output values and stores the vector to the specified variable. More...
override void | TransfNeuralToSimulationOutput (IVector original, ref IVector result)
| Transforms the specified vector of neural output values to the vector of simulation output values (results) and stores the vector to the specified variable. More...
Public Member Functions inherited from IG.Script.LoadableScriptShellNeuralBase
| LoadableScriptShellNeuralBase ()
override void | Analyse (Num.IAnalysisResults anRes)
| Dummy analysis, jsut throws the exception. More...
virtual string | Test (string[] arguments)
| Runs a custom basic test. More...
virtual string | Custom (string[] arguments)
| Runs a custom test. More...
virtual string | RunParallelSimulations (string[] arguments)
| Runs multiple simulations in parallel threads and saves results in each parallel thread. More...
virtual string | CollectParallelSimulationResults (string[] arguments)
| Collects results of simulations run in parallel threads, joins them into a single object and saves them. More...
override void | Script_AddCommands (ICommandLineApplicationInterpreter interpreter, SortedList< string, string > helpStrings)
| Adds commands to the internal interpreter. More...
virtual IVector | TestApproximation (IVector parameters)
| Performs a test approximation at the specified vector of parameters and outputs and returns results. More...
virtual IVector[][] | TestApproximationTable (int numPoints)
| Calculates a table of specified number of approximations, with parameters running between two points that are chosen by the algorithm. More...
virtual IVector[][] | TestApproximationTable (IVector param1, IVector param2, int numPoints)
| Performs a table of approximatinos between two specified vectors of approximation input parameters, and outputs results. It also returns the table of results (approximated output values in form of vectors). More...
virtual AnalysisResults | TestAnalysis (IVector parameters)
| Performs test analysis at the specified optimization parameters and outputs results. More...
virtual AnalysisResults[] | TestAnalysisTable (int numPoints)
| Calculates a table of specified number of analyses, with parameters running between two points that are chosen by the algorithm. More...
virtual AnalysisResults[] | TestAnalysisTable (IVector param1, IVector param2, int numPoints)
| Performs a table of direct analyses between two specified vectors of optimization parameters, and outputs results. It also returns the table of analysis results. More...
virtual void | OptimizeSimplex ()
virtual void | TransfNeuralToOptimizationParameters (IVector neuralParameters, ref IVector optimizationParameters)
| Maps input parameters for neural network to optimization input parameters. More...
virtual void | TransfOptimizationToNeuralParameters (IVector optimizationParameters, ref IVector neuralParameters)
| Maps optimization input parameters to neural network input parameters. More...
delegate string | ParallelRunDelegate (int threadIndex)
virtual void | ParSimBegin (int numThreads)
| Launches parallel jobs. More...
virtual void | GatherParallelResults (int numThreads)
| Reads results form all parallel threads, gathers them in a single training set, and saves them in the template optimiation directory. More...
virtual string | ParSimGetOptimizationDirectoryPath (int threadIndex)
| Returns path to the directory containing optimization data for the specified parallel thread. More...
virtual string | ParSimGetMutexName (int threadIndex)
| Returns name of the mutex for locking data on disk that is used by the specified parallel thread. More...
virtual string | ParSimGetParallelResultsFilePath (int threadIndex)
| Returns path of the file where resuls of calculation in the specified parallel thread are stored. More...
virtual string | GetParallelResultFilePath ()
| Returns path of the file where resuls of calculation in the specified parallel thread are stored. More...
virtual void | ParSimPreparelDirectory (int threadIndex)
| Prepares data for running calculations in the parallel thread with the specified index. More...
void | ParSimAddResults (int threadIndex, SampledDataSet results)
| Reads results of the specified thread and adds them to the existing training set. More...
string | ParSimRunJob (int threadIndex)
| Runs the job in the specified parallel thread. More...
virtual void | ParSimGetNextInput (ref IVector simInput)
| Generates the next vector of simulation input parameters that will be used for calculation of a new parallel simulation. More...
virtual void | ParSimGetNextNeuralInput (ref IVector simInput)
| Generates the next vector of neural input parameters that will be used for calculation of a new training element. More...
virtual string | ParSimGetSimulationDirectoryPath (int threadIndex)
| Returns the simulation directory for the specified parallel calculation thread. More...
virtual IResponseEvaluatorVectorSimple | ParSimGetSimulator (int threadIndex)
| Creates simulator file manager for the simulator that will the specified parallel task. More...
virtual SampledDataElement | GetTrainingElement (int i)
| Gets the training element with the specified index (chosen out of al training points, including verificaion points). More...
virtual bool | IsVerificationPoint (int trainingPointIndex)
| Whether the training point with the specified index is a verification points and has not been used in training. More...
List< SampledDataElement > | GetTrainingElements (bool includeVerificationPoints)
| Returns a list of all neural training elements. More...
List< SampledDataElement > | GetTrainingElements (bool includeVerificationPoints, bool includeNonVerificationPoints)
| Returns a list of all neural training elements. More...
virtual void | GetNeuralInputPerturbance (double ratio, ref IVector perturbance)
| Returns a perturbance vector whose componenets represent magnitudes of perturbances of neural input parameters with the specified relative ratio with corresponding parameters' scaling lengths. More...
virtual void | GetNeuralOutputPerturbance (double ratio, ref IVector perturbance)
| Returns a perturbance vector whose componenets represent magnitudes of perturbances of neural output values with the specified relative ratio with corresponding values' scaling lengths. More...
virtual void | GetNeuralInputVector (double relativeComponents, ref IVector inputVector)
| Returns an input vector whose components are at specified relative distances (with respect to full range) from lower bounds on componens of input vectors. More...
virtual void | GetNeuralOutputVector (double relativeComponents, ref IVector outputVector)
| Returns an output vector whose components are at specified relative distances (with respect to full range) from lower bounds on componens of input vectors. More...
virtual void | GetNeuralInputVector (IVector relativeComponents, ref IVector inputVector)
| Returns an input vector whose components are at specified relative distances (with respect to full range) from lower bounds on componens of input vectors. More...
virtual void | GetNeuralOutputVector (IVector relativeComponents, ref IVector outputVector)
| Returns an output vector whose components are at specified relative distances (with respect to full range) from lower bounds on componens of input vectors. More...
virtual void | GetNeuralInputRelative (IVector inputVector, ref IVector relativeComponents)
| Calculates relative components (running from 0 to 1 within bounds for specified vector component) for the specified vector of neural input parameters. More...
virtual void | GetNeuralOutputRelative (IVector outputVector, ref IVector relativeComponents)
| Calculates relative components (running from 0 to 1 within bounds for specified vector component) for the specified vector of neural output values. More...
virtual double | InputDistance (IVector v1, IVector v2)
| Returns measure of distance between two vectors in the space of input parameters. Euclidean norm scaled accorging to individual parameter ranges is returned. More...
virtual double | OutputDistance (IVector v1, IVector v2)
| Returns measure of distance between two vectors in the space of output parameters. Euclidean norm scaled accorging to individual parameter ranges is returned. More...
virtual double | InputDistance (IVector v1, int trainingPointIndex)
| Returns measure of distance between the specified neural input vector and vector of input parameters of the training point with the specified index. More...
virtual double | OutputDistance (IVector v1, int trainingPointIndex)
| Returns measure of distance between the specified neural output values vector and vector of output values of the training point with the specified index. More...
virtual int | GetClosestInputIndex (IVector v1, bool includeVerificationPoints)
| Returns index of training element with the shortest distance of its input parameters to the specified vector. More...
virtual int | GetClosestOutputIndex (IVector v1, bool includeVerificationPoints)
| Returns index of training element with the shortest distance of its output values to the specified vector of output values. More...
void | TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, params IVector[] points)
| For each point in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
void | TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, bool printIndividualPointsComp, params IVector[] points)
| For each point in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
void | TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, params SampledDataElement[] points)
| For each point (training element) in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
void | TestClosestPoints (int numClosestPoints, bool includeVerificationPoints, bool printByComponents, bool printIndividualPointsComp, params SampledDataElement[] points)
| For each point (training element) in the specified array, the training points are sorted according to the distance to this point, and data for the specified number of closest points are written. More...
virtual void | NeuralCalculate (params double[] inputParameters)
| Calculates approximation at specified input parameters. More...
virtual void | NeuralCalculate (IVector inputParameters)
| Calculates approximation at specified input parameters. More...
virtual void | NeuralCalculate (IVector inputParameters, ref IVector outputValues)
| Calculates approximation at specified input parameters. More...
virtual List< SampledDataElement > | GetRandomTrainingElements (int numElements, bool includeVerificationPoints)
| Creates and returns a list of training elements that are randomly chosen from the current training set. Trainingpoints that are not verification points are always included in the set of points for selection. More...
virtual List< SampledDataElement > | GetRandomTrainingElements (int numElements, bool includeVerificationPoints, bool includeNonVerificationPoints)
| Creates and returns a list of training elements that are randomly chosen from the current training set. More...
virtual List< SampledDataElement > | GetRandomTrainingElements (IRandomGenerator rand, int numElements, bool includeVerificationPoints)
| Creates and returns a list of training elements that are randomly chosen from the current training set. Trainingpoints that are not verification points are always included in the set of points for selection. More...
virtual List< SampledDataElement > | GetRandomTrainingElements (IRandomGenerator rand, int numElements, bool includeVerificationPoints, bool includeNonVerificationPoints)
| Creates and returns a list of training elements that are randomly chosen from the current training set. More...
virtual IVector | GetRandomNeuralInput ()
| Creates and returns a random vector of neural input parameters whose elements (components) lie within the lower and upper bounds on parameters. More...
virtual void | GetRandomNeuralInput (IRandomGenerator rand, ref IVector result)
| Generates a random vector of neural input parameters whose elements (components) lie within the lower and upper bounds on parameters, and stores it to the specified vector. More...
virtual IVector | GetRandomNeuralInput (IRandomGenerator rand)
| Creates and returns a random vector of neural input parameters whose elements (components) lie within the lower and upper bounds on parameters. More...
virtual void | GetRandomNeuralInput (ref IVector result)
| Generates a random vector of neural input parameters whose elements (components) lie within the lower and upper bounds on parameters. More...
virtual IVector | GetRandomNeuralOutput ()
| Creates and returns a random vector of neural output values whose elements (components) lie within the lower and upper bounds on values. More...
virtual IVector | GetRandomNeuralOutput (IRandomGenerator rand)
| Creates and returns a random vector of neural output values whose elements (components) lie within the lower and upper bounds on values. More...
virtual void | GetRandomNeuralOutput (ref IVector result)
| Generates a random vector of neural output values whose elements (components) lie within the lower and upper bounds on values. More...
virtual void | GetRandomNeuralOutput (IRandomGenerator rand, ref IVector result)
| Generates a random vector of neural output values whose elements (components) lie within the lower and upper bounds on neural output values, and stores it to the specified vector. More...
virtual void | PrepareNeuronsTable (int minNeurons, int maxNeurons, int numNeurons, ref int[] neurpnsTable)
| Prepares table of neurons in geometric sequence. More...
void | TrainANN (int annType, int NumNeurons, int MaxEpochs, int EpochsInBundle, double LearnignRate, double Momentum, double InputSafetyFactor, double OutputSafetyFactor, double PercentVerificationPoints)
| Train the artificial neural network. More...
virtual string | CreateDistortedModelData (string[] arguments)
| Creates data for distorted model and stores the data in the specified directory. More...
virtual void | TestDistances (int referencePointIndex, int maxNumPoints)
| Test of distances of a specified number of training points with respect to the training point with specified index, in the input parameters space as well as in the output parameter space. More...
virtual void | TestNeuralSpeed (int numEvaluations)
| Performs test of speed of calculation of neural network. More...
virtual void | PrintNeuralData ()
| This example demonstrates how to extract data necessary for definition of optimization problems. More...
void | SaveSensitivityCSV ()
| Saves sensitivity test in csv file. More...
Public Member Functions inherited from IG.Lib.LoadableScriptShellBase
| LoadableScriptShellBase ()
| Constructor. More...
virtual bool | RepairSimulationParameters (IVector parameters)
| Repairs simulation parameters, if necessary, in such a way that values are consistent with simuation data (e.g. spacing of nodes). More...
virtual void | SimulatorCalculateResponse (IResponseEvaluatorVectorSimple simulator, IVector inputParameters, ref IVector outputValues)
| Calculates vector response by the specified simulator, and stores output values to the specified vector variable. More...
void | SimulatorCalculateResponse (IVector parameters, ref IVector outputValues)
| Calculates vector response by the main simulator of the script, and stores output values to the specified vector variable. More...
Public Member Functions inherited from IG.Lib.LoadableScriptOptShellBaseControllable
| LoadableScriptOptShellBaseControllable ()
| Creates a LoadableScriptOptBase object. More...
Public Member Functions inherited from IG.Lib.LoadableScriptOptBase
| LoadableScriptOptBase ()
| Creates the LoadableScriptOptBase object. More...
abstract void | Analyse (IAnalysisResults anRes)
| Performs direct analysis for optimization problems. This method must be overridden in derived classes where one wants to have direct analysis defined. More...
Public Member Functions inherited from IG.Lib.LoadableScriptBase
| LoadableScriptBase ()
| Argument-less constructor. If argument-less constructor is called then initialization is not performed and will be performed later. More...
string | Run (string[] arguments)
| Performs the action of this object. Override this in derived classes! More...
void | Initialize (string[] arguments)
| Initializes the object. If not called explicitly, this method is automatically called at the first call to the Run method. More...
virtual string | Script_DefaultInitialize (string[] arguments)
| Default initialization method for scripts. More...
virtual string | Script_DefaultRun (string[] arguments)
| Default run method for the script. Can be used when only installed commands are run by hte script. More...
virtual ICommandLineApplicationInterpreter | Script_CreateInterpreterWithoutCommands ()
| Creates and returns an interpreter that can be used as script's internal interpreter for running script's commands. More...
delegate string | Script_CommandDelegate (string[] args)
| Delegate for commands that are installed on script's internal interpreter (property Script_Interpreter). More...
void | Script_AddCommand (string commandName, Script_CommandDelegate command, string helpString)
| Adds a new internal script command under specified name to the internal interpreter of the current script object. More...
virtual void | Script_AddCommand (ICommandLineApplicationInterpreter interpreter, SortedList< string, string > helpStrings, string commandName, Script_CommandDelegate command, string helpString)
| Adds a new internal script command under specified name to the internal interpreter of the current script object. More...
string | Script_GetHelpString (string scriptCommandName)
| Returns help string for internal script command with specified name, or null if help string is not installed for such a command. More...
void | Script_PrintCommandsHelp ()
| Prits help for the installed internal commands of the script. More...
virtual bool | Script_ContainsCommand (string commandName)
| Returns true if the internal script's interpreter contains a command with specified name, false otherwise. More...
virtual bool | Script_ContainsScriptCommand (string commandName)
| Returns true if the specified command is script command (i.e. its first argument is command-name and it is run through the Script_CommandAdapter object). More...
virtual void | Script_RemoveCommand (string commandName)
| Removes the specified internal script command from the internal interpreter of the current scripting object. More...
virtual void | Script_RemoveAllCommands ()
| Removes ALL internal script commands from the internal interpreter of the current scripting object. More...
string | Script_Run (string[] arguments)
| Runs internal script command. More...
string | Script_Run (string commandName, params string[] otherArguments)
| Runs internal script command. More...
virtual void | Script_PrintArguments (string messageString, string[] arguments)
| Prints the specified array of string arguments (usually passed as command-line arguments). More...

## Protected Member Functions
override void | InitializeThis (string[] arguments)
| Inializes the current script object. More...
override string | RunThis (string[] arguments)
| Throws NotImplementedException. More...
Protected Member Functions inherited from IG.Script.LoadableScriptShellNeuralBase
override void | InitializeThis (string[] arguments)
| Inializes the current script object. More...
virtual void | LoadJson (string path, ref INeuralApproximator network)
| Loads the neural network approximator from the specified file. More...
virtual void | SaveJson (INeuralApproximator approximator, string trainedNetworkFilePath)
| Saves the specified trained network to a file. More...
virtual INeuralApproximator | CreateApproximator (int annType=2)
| Creates and returns a new neural network approximator, with the basic properties pre-set to default values, dependent on the type of the requires approximator. More...
virtual void | PrintInternalCommandAndArguments (string[] arguments)
| Prints internal command being executed and its actual arguments More...
virtual void | GetSimulationInputDefault (ref IVector result)
| Gets the vector of default values of simulation parameters and stores it in the specified vector. More...
virtual void | GetSimulationInputMin (ref IVector result)
| Gets the vector of lower bounds on simulation parameters and stores it in the specified vector. More...
virtual void | GetSimulationInputMax (ref IVector result)
| Gets the vector of upper bounds on simulation parameters and stores it in the specified vector. More...
virtual void | ParSimPrepareDirectories (int numThreads)
| Prepares data for the specified number of parallel execution threads. More...
virtual void | ParSimWaitAllCompletion ()
| Waits until all parallel jobs complete. More...
virtual void | ParSimAsyncCallback (IAsyncResult ar)
| Callback method for asynchronous runs. More...
virtual string | ParSimGetDirectoryExtension (int threadIndex)
| Returns directory extension for data directory used in the specified parallel calculation thread. More...
virtual void | GetNeuralInputDefault (ref IVector result)
| Gets the vector of default values of neural parameters and stores it in the specified vector. More...
virtual void | GetNeuralInputMin (ref IVector result)
| Gets the vector of lower bounds on neural parameters and stores it in the specified vector. More...
virtual void | GetNeuralInputMax (ref IVector result)
| Gets the vector of upper bounds on neural parameters and stores it in the specified vector. More...
virtual void | GetRandomNeuralInputFromDataDefinition (IRandomGenerator rand, ref IVector result)
| Generates a random vector of neural input parameters whose elements (components) lie within the lower and upper bounds on parameters, and stores it to the specified vector. More...
Protected Member Functions inherited from IG.Lib.LoadableScriptShellBase
virtual void | CreateNewSimulator (string simulatorPath, ref IResponseEvaluatorVectorSimple simulator)
| Creates a new simulator that uses the specified simulator directory, and stores it to the specified variable. More...
Protected Member Functions inherited from IG.Lib.LoadableScriptBase
delegate string | CommandMethod (string commandName, string[] args)
| Delegate for internal command methods. More...
ICommandLineApplicationInterpreter | Script_CreateInterpreter ()
| Creates and returns an interpreter that can be used as script's internal interpreter for running script's commands. More...
virtual string | Script_CommandHelp (string[] arguments)
| Prints help. More...
virtual string | Script_CommandTestScript (string[] arguments)
| Prints help. More...

## Properties
override IResponseEvaluatorVectorSimple | Simulator`[get, protected set]`
override int | NumOptimizationParameters`[get, protected set]`
| Throws NotImplementedException. More...
override int | NumOptimizationConstraints`[get, protected set]`
| Throws NotImplementedException. More...
Properties inherited from IG.Script.LoadableScriptShellNeuralBase
abstract int | NumOptimizationParameters`[get, protected set]`
| Number of optimization parameters. More...
abstract int | NumOptimizationConstraints`[get, protected set]`
| Number of optimization constraints. More...
virtual InputOutputDataDefiniton | SimulationDataDefinition`[get]`
| Simulation data definition (input and output used by simulator). More...
virtual int | NumSimulationParameters`[get, protected set]`
| Number of simulation input parameters. More...
virtual int | NumSimulationOutputs`[get, protected set]`
| Number of simulation output values. More...
virtual IBoundingBox | SimulationInputBounds`[get, protected set]`
| Bounds on simulation input parameters. More...
string | ParallelResultsFileExtension`[get, protected set]`
virtual NeuraApproximationFileManager | NeuralFM`[get]`
| File manager that provides access to trained neural network and related data. More...
virtual INeuralApproximator | TrainedNetwork`[get, protected set]`
| Trained neural network. More...
virtual List< IVector > | SensitivityVerificationResults`[get, protected set]`
virtual List< IVector > | SensitivityTrainingResults`[get, protected set]`
virtual INeuralApproximator | XXX_TrainedNetwork`[get, protected set]`
| Trained neural network. More...
virtual InputOutputDataDefiniton | NeuralDataDefinition`[get, protected set]`
| Neural data definition. More...
virtual SampledDataSet | TrainingData`[get, set]`
virtual SampledDataSet | VerificationData`[get, set]`
virtual int | NumNeuralParameters`[get, protected set]`
| Number of neural network input parameters. More...
virtual int | NumNeuralOutputs`[get, protected set]`
| Number of neural network output values. More...
virtual IBoundingBox | NeuralInputBounds`[get, protected set]`
| Bounds on neural input parameters. More...
virtual SampledDataSet | NeuralTrainingData`[get]`
| Gets the training data. More...
virtual int | NumAllTrainingPoints`[get]`
| Gets number of all training points, including verification points. More...
virtual IVector | SomeNeuralInput`[get]`
| Returns some vector of input parameters that is within the range. More...
virtual IVector | NeuralInputFromFile`[get]`
| Vector of input parameters read form the file. More...
Properties inherited from IG.Lib.LoadableScriptShellBase
abstract IResponseEvaluatorVectorSimple | Simulator`[get, protected set]`
| Simulator that is used to calculate vector response. More...
virtual bool | SimulatorSuppressOutput`[get, set]`
| A flag indicating whether simulators should suppress output or not, default is false. More...
virtual string | ProjectName`[get, protected set]`
| Name of the current project, used in some simulation and other interfaces. More...
virtual string | SimulationName`[get, protected set]`
| Name of the current simulation, used in some simulation and other interfaces. More...
Properties inherited from IG.Lib.LoadableScriptOptShellBaseControllable
bool | IsLoadable`[get, set]`
| Either or not the script can be dynamically loaded. More...
bool | IsRunnable`[get, set]`
| Either or not the script can be run (some scripts only support other tasks). More...
Properties inherited from IG.Lib.LoadableScriptOptBase
StopWatch1 | Timer`[get]`
virtual IRandomGenerator | Random`[get, protected set]`
| Random generator used by the current object. More...
virtual string | OptimizationDirectory`[get, set]`
| Optimization directory. This directory is a base directory for data used optimization and neural network - based approximation servers and for other directories that contain data for specific tasks. More...
virtual string | WorkingDirectory`[get, set]`
| Working directory. This directory is a base directory for data used by the script. It is usually obtained as parent directory of the optimization directory. More...
virtual IAnalysis | Analysis`[get, protected set]`
| Direct analysis object used in optimization. Initialized when first accessed with the embedded class, whose analysis function calls Analyse(...). More...
Properties inherited from IG.Lib.LoadableScriptBase
string | EmbeddedCommandName`[get, set]`
| Command that was used to launch the current embedded application script. More...
object | Lock`[get]`
| This object's central lock object to be used by other object. Do not use this object for locking in class' methods, for this you should use InternalLock. More...
string[] | InitializationArguments`[get, set]`
| Arguments used by the initialization method. WARNING: arguments can only be set before initialization is performed. Initialization is performed either implicitly at the first call to the Run method or explicitly by calling the Initialize method. More...
virtual bool | IsInitialized`[get, protected set]`
| Whether the object has been initialized or not. More...
static int | DefaultOutputLevel`[get, set]`
int | OutputLevel`[get, set]`
| Level of output to console produced by some operations of the current object. More...
virtual ICommandLineApplicationInterpreter | Script_Interpreter`[get, protected set]`
| Script's internal interpreter that takes care for execution of installed internal commands. More...
SortedList< string, string > | Script_CommandHelpStrings`[get]`
| Contains help strings associated with script commands installed on interpreter. More...
Properties inherited from IG.Lib.ILoadableScript
string | EmbeddedCommandName`[get, set]`
| Command that was used to launch the current embedded application script. More...
string[] | InitializationArguments`[get, set]`
| Arguments used by the initialization method. More...
bool | IsInitialized`[get]`
| Whether the object has been initialized or not. More...
Properties inherited from IG.Lib.ILockable
object | Lock`[get]`
Properties inherited from IG.Lib.ILoadableScriptC
bool | IsLoadable`[get, set]`
| Either or not the script can be dynamically loaded. More...
bool | IsRunnable`[get, set]`
| Either or not the script can be run (some scripts only support other tasks). More...
Properties inherited from IG.Num.INeuralModel
INeuralApproximator | TrainedNetwork`[get]`
| Traint artificial neural network. More...
InputOutputDataDefiniton | NeuralDataDefinition`[get]`
| Neural data definition. More...

## Additional Inherited Members
Public Attributes inherited from IG.Script.LoadableScriptShellNeuralBase
const string | ConstTest = "Test"
| Comamnd name for test. More...
const string | ConstHelpTest = "Test of functionality."
const string | ConstCustom = "Custom"
| Comamnd name for test. More...
const string | ConstHelpCustom = "Custom command that can be quickly modified as needed, for performing."
const string | ConstRunParallel = "RunParallel"
| Comamnd name for running parallel simulations. More...
const string | ConstHelpRunParallel = "Runs parallel simulations. Args: numThreads numRunsPerThread"
const string | ConstCollectParallel = "collectparallel"
| Comamnd name for running parallel simulations. More...
const string | ConstHelpCollectParallel = "Collects results of parallel simulations. Args: numThreads"
const string | ConstCreateDistortedModelData = "CreateDistortedModelData"
| Comamnd name for testing network response for centered point from verification or training points for all Inputs/outputs. More...
const string | ConstHelpCreateDistortedModelData
string | ParallelResultsFilename = "ParallelResults"
int | ParSimNumRuns = 2
| Number of runs of simulator in each parallel thread. More...
int | ParSimNumThreads = 2
| Number of jobs that can be executed in parallel. More...
int | ParSimSavingFrequency = 4
| Specifies how often the results are saved. More...
string | ParSimResultFilename = "GatheredNeuralTrainingData.json"
bool | saveGraphs = false
Public Attributes inherited from IG.Lib.LoadableScriptBase
const string | ConstDefaultHelp = "Help"
| Default command name for help. More...
const string | ConstHelpDefaultUniversal = "?"
| Universal name of the help command. More...
const string | ConstDefaultTestScrip = "TestScript"
| Default command name for test method. More...
Static Public Attributes inherited from IG.Script.LoadableScriptShellNeuralBase
static string | TrainedNetworkAlternativeLovation = null
| If different than null, this static property provides alternative location of the file which neural network approximator is resd from, in terms of path relative to optimization directory. More...
Protected Attributes inherited from IG.Script.LoadableScriptShellNeuralBase
IVector | _simulationInputDefault
IVector | _simulationInputMin
IVector | _simulationInputMax
IBoundingBox | _simulationInputBounds
string | _parallelResultsFilename = "ParallelResults"
string | _parallelResultsFileExtension = ".json"
List< IAsyncResult > | ParallelResults
object | ParSimProcessDelayLock = new object()
int | ParSimProcessDelayMilliseconds = 500
| Minimal delay between two successive launches of simulator processes, in milliseconds. This delay is introduced in order to prevent unusual errors that occur when running two simulator processes at approcimately the same time (although they use completely separate data directory structures). More...
List< IVector > | _sensitivityResultsVerification
List< IVector > | _sensitivityResultsTraining
INeuralApproximator | _trainedNetwork
SampledDataSet | _trainingData
SampledDataSet | _verificationData
IVector | _neuralInputDefault
IVector | _neuralInputMin
IVector | _neuralInputMax
IBoundingBox | _neuralInputBounds
Protected Attributes inherited from IG.Lib.LoadableScriptShellBase
IResponseEvaluatorVectorSimple | _simulator
string | _projectName
string | _simulationName
Protected Attributes inherited from IG.Lib.LoadableScriptOptBase
StopWatch1 | _timer = null
bool | _checkOptimizationDirectoryExistence = true
| Whether to check existence of optimization directory when set. Also applies to working directory. More...
Protected Attributes inherited from IG.Lib.LoadableScriptBase
string | _embeddedCommandName = null
int | _outputLevel = DefaultOutputLevel
ICommandLineApplicationInterpreter | _script_interpreter

## Detailed Description

Base class for loadable scripts that are used as custom applications that inclued neural networks approximations and optimization.

This is a concrete class. It implements abstract methods from LoadableScriptShellNeuralBase, in sime cases providing logical default implementations, but in some cases these implementations just throw exception.

Sometimes you might check if you have implemented everything as necessary in the derived class. The trick is simply to derive from LoadableScriptShellNeuralBase instead of this class, and check by compiler which abstract methods remained unimplemented in your class.

$A Igor xx Feb12;

## Constructor & Destructor Documentation

IG.Script.LoadableScriptShellNeural.LoadableScriptShellNeural | ( |  | ) |
| inline

## Member Function Documentation

override void IG.Script.LoadableScriptShellNeural.InitializeThis | ( | string[] | arguments | ) |
| inline protected virtual

Inializes the current script object.

Parameters

  arguments | Initialization arguments. The first argument must be the working directory path.

Reimplemented from IG.Lib.LoadableScriptShellBase.

override string IG.Script.LoadableScriptShellNeural.RunThis | ( | string[] | arguments | ) |
| inline protected virtual

Throws NotImplementedException.

Implements IG.Lib.LoadableScriptBase.

override void IG.Script.LoadableScriptShellNeural.Analyse | ( | Num.IAnalysisResults | anRes | ) |
| inline

Dummy analysis, jsut throws the exception.

Parameters

  anRes |

NotImplementedException

override void IG.Script.LoadableScriptShellNeural.TransfSimulationToNeuralInput | ( | IVector | original,
|  | ref IVector | result
| ) |  |
| inline virtual

Transforms the specified vector of simulation input parameters to the vector of neural input parameters and stores the vector to the specified variable.

Parameters

  original | Vector to be transformed.
  result | Vector where result of transformation is stored.

Implements IG.Script.LoadableScriptShellNeuralBase.

override void IG.Script.LoadableScriptShellNeural.TransfNeuralToSimulationInput | ( | IVector | original,
|  | ref IVector | result
| ) |  |
| inline virtual

Transforms the specified vector of neural input parameters to the vector of simulation input parameters and stores the vector to the specified variable.

Parameters

  original | Vector to be transformed.
  result | Vector where result of transformation is stored.

Reimplemented from IG.Script.LoadableScriptShellNeuralBase.

override void IG.Script.LoadableScriptShellNeural.TransfSimulationToNeuralOutput | ( | IVector | original,
|  | ref IVector | result
| ) |  |
| inline virtual

Transforms the specified vector of simulation output values (results) to the vector of neural output values and stores the vector to the specified variable.

Parameters

  original | Vector to be transformed.
  result | Vector where result of transformation is stored.

Reimplemented from IG.Script.LoadableScriptShellNeuralBase.

override void IG.Script.LoadableScriptShellNeural.TransfNeuralToSimulationOutput | ( | IVector | original,
|  | ref IVector | result
| ) |  |
| inline virtual

Transforms the specified vector of neural output values to the vector of simulation output values (results) and stores the vector to the specified variable.

Parameters

  original | Vector to be transformed.
  result | Vector where result of transformation is stored.

Reimplemented from IG.Script.LoadableScriptShellNeuralBase.

## Property Documentation

override IResponseEvaluatorVectorSimple IG.Script.LoadableScriptShellNeural.Simulator
| get protected set

override int IG.Script.LoadableScriptShellNeural.NumOptimizationParameters
| get protected set

Throws NotImplementedException.

override int IG.Script.LoadableScriptShellNeural.NumOptimizationConstraints
| get protected set

Throws NotImplementedException.

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

- extensions/iglibneural/neural/scripts_base/ScriptShellNeural.cs