IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Script.ScriptExtNumeric Class Reference
+ Inheritance diagram for IG.Script.ScriptExtNumeric:
+ Collaboration diagram for IG.Script.ScriptExtNumeric:

Public Member Functions

 ScriptExtNumeric ()
 
override void Script_AddCommands (ICommandLineApplicationInterpreter interpreter, SortedList< string, string > helpStrings)
 Adds commands to the internal interpreter. More...
 
string TestScriptArguments (string[] arguments)
 Simple test, just writes script arguments to console. More...
 
string TestScalarFunctions (string[] arguments)
 Test of tables of results (e.g. tables of approximated values or of optimization analysis results). More...
 
string TestParallelJobs (string[] arguments)
 Test of tables of results (e.g. tables of approximated values or of optimization analysis results). More...
 
string ANNOptimalParam (string[] arguments)
 Test of optimal ANN training parameters. 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...
 

Public Attributes

const string ConstScalarFunctions = "ScalarFunctions"
 Tests scalar functions. More...
 
const string ConstHelpScalarFunctions = "Tests of scalar functions."
 
const string ConstParallelJobs = "ParallelJobs"
 Tests parallel job dispatcher. More...
 
const string ConstHelpParallelJobs = "Testing of parallel job dispatcher."
 
const string ConstANNOptimalParam = "annoptimalparam"
 
const string ConstHelpANNOptimalParam = "Testing of optimal ANN training parameters."
 
- 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...
 

Protected Member Functions

override void InitializeThis (string[] arguments)
 Initializes the current object. More...
 
override string RunThis (string[] arguments)
 Runs action of the current object. 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...
 

Additional Inherited Members

- Protected Attributes inherited from IG.Lib.LoadableScriptBase
string _embeddedCommandName = null
 
int _outputLevel = DefaultOutputLevel
 
ICommandLineApplicationInterpreter _script_interpreter
 
- 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]
 

Constructor & Destructor Documentation

IG.Script.ScriptExtNumeric.ScriptExtNumeric ( )
inline

Member Function Documentation

override void IG.Script.ScriptExtNumeric.InitializeThis ( string[]  arguments)
inlineprotectedvirtual

Initializes the current object.

Implements IG.Lib.LoadableScriptBase.

override string IG.Script.ScriptExtNumeric.RunThis ( string[]  arguments)
inlineprotectedvirtual

Runs action of the current object.

Parameters
argumentsCommand-line arguments of the action.

Implements IG.Lib.LoadableScriptBase.

override void IG.Script.ScriptExtNumeric.Script_AddCommands ( ICommandLineApplicationInterpreter  interpreter,
SortedList< string, string >  helpStrings 
)
inlinevirtual

Adds commands to the internal interpreter.

Parameters
interpreterInterpreter where commands are executed.
helpStringsList containg help strings.

Reimplemented from IG.Lib.LoadableScriptBase.

string IG.Script.ScriptExtNumeric.TestScriptArguments ( string[]  arguments)
inline

Simple test, just writes script arguments to console.

Parameters
argumentsArray of command-line arguments.
Returns
The null string.
string IG.Script.ScriptExtNumeric.TestScalarFunctions ( string[]  arguments)
inline

Test of tables of results (e.g. tables of approximated values or of optimization analysis results).

Parameters
argumentsArray of command-line arguments.
Returns
The null string.

References IG.Num.IVector.SetConstant(), IG.Num.ScalarFunctionUntransformedBase.TestGradient(), IG.Num.ScalarFunctionUntransformedBase.TestHessian(), and IG.Num.ScalarFunctionUntransformedBase.TestSpeed().

string IG.Script.ScriptExtNumeric.TestParallelJobs ( string[]  arguments)
inline

Test of tables of results (e.g. tables of approximated values or of optimization analysis results).

Parameters
argumentsArray of command-line arguments.
Returns
The null string.

References IG.Num.ParallelJobContainerBase.DefaultOutputLevel, and IG.Num.ParallelJobContainerBase.TestPerformance().

string IG.Script.ScriptExtNumeric.ANNOptimalParam ( string[]  arguments)
inline

Test of optimal ANN training parameters.

Parameters
argumentsArray of command-line arguments.
Returns
The null string.

References IG.Num.ParallelJobContainerBase.DefaultOutputLevel, and IG.Num.ParallelJobContainerBase.TestPerformance().

Member Data Documentation

const string IG.Script.ScriptExtNumeric.ConstScalarFunctions = "ScalarFunctions"

Tests scalar functions.

const string IG.Script.ScriptExtNumeric.ConstHelpScalarFunctions = "Tests of scalar functions."
const string IG.Script.ScriptExtNumeric.ConstParallelJobs = "ParallelJobs"

Tests parallel job dispatcher.

Referenced by IG.Test.ProgramTestIgorIT.TestMain().

const string IG.Script.ScriptExtNumeric.ConstHelpParallelJobs = "Testing of parallel job dispatcher."
const string IG.Script.ScriptExtNumeric.ConstANNOptimalParam = "annoptimalparam"
const string IG.Script.ScriptExtNumeric.ConstHelpANNOptimalParam = "Testing of optimal ANN training parameters."

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