ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkAmoebaMinimizer Class Reference

vtkAmoebaMinimizer - nonlinear optimization with a simplex More...

Inheritance diagram for Kitware.VTK.vtkAmoebaMinimizer:
[legend]
Collaboration diagram for Kitware.VTK.vtkAmoebaMinimizer:
[legend]

List of all members.

Public Member Functions

 vtkAmoebaMinimizer (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkAmoebaMinimizer ()
 Undocumented Block.
void EvaluateFunction ()
 Evaluate the function. This is usually called internally by the minimization code, but it is provided here as a public method.
virtual int GetFunctionEvaluations ()
 Return the number of times that the function has been evaluated.
double GetFunctionValue ()
 Get the function value resulting from the minimization.
virtual int GetIterations ()
 Return the number of interations that have been performed. This is not necessarily the same as the number of function evaluations.
virtual int GetMaxIterations ()
 Specify the maximum number of iterations to try before giving up.
int GetNumberOfParameters ()
 Get the number of parameters that have been set.
string GetParameterName (int i)
 For completeness, an unchecked method to get the name for particular parameter (the result will be NULL if no name was set).
double GetParameterScale (string name)
 Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.
double GetParameterScale (int i)
 Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.
double GetParameterValue (string name)
 Get the value of a parameter at the current stage of the minimization. Call this method within the function that you are minimizing in order to get the current parameter values. It is preferable to specify parameters by name rather than by index.
double GetParameterValue (int i)
 Get the value of a parameter at the current stage of the minimization. Call this method within the function that you are minimizing in order to get the current parameter values. It is preferable to specify parameters by name rather than by index.
virtual double GetTolerance ()
 Specify the fractional tolerance to aim for during the minimization.
void Initialize ()
 Initialize the minimizer. This will reset the number of parameters to zero so that the minimizer can be reused.
override int IsA (string type)
 Undocumented Block.
virtual int Iterate ()
 Perform one iteration of minimization. Returns zero if the tolerance stopping criterion has been met.
virtual void Minimize ()
 Iterate until the minimum is found to within the specified tolerance, or until the MaxIterations has been reached.
new vtkAmoebaMinimizer NewInstance ()
 Undocumented Block.
virtual void SetFunctionValue (double _arg)
 Get the function value resulting from the minimization.
virtual void SetMaxIterations (int _arg)
 Specify the maximum number of iterations to try before giving up.
void SetParameterScale (string name, double scale)
 Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.
void SetParameterScale (int i, double scale)
 Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.
void SetParameterValue (string name, double value)
 Set the initial value for the specified parameter. Calling this function for any parameter will reset the Iterations and the FunctionEvaluations counts to zero. You must also use SetParameterScale() to specify the step size by which the parameter will be modified during the minimization. It is preferable to specify parameters by name, rather than by number.
void SetParameterValue (int i, double value)
 Set the initial value for the specified parameter. Calling this function for any parameter will reset the Iterations and the FunctionEvaluations counts to zero. You must also use SetParameterScale() to specify the step size by which the parameter will be modified during the minimization. It is preferable to specify parameters by name, rather than by number.
virtual void SetTolerance (double _arg)
 Specify the fractional tolerance to aim for during the minimization.

Static Public Member Functions

static new vtkAmoebaMinimizer New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkAmoebaMinimizer SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkAmoebaMinimizer"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "18vtkAmoebaMinimizer"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkAmoebaMinimizer_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkAmoebaMinimizer_EvaluateFunction_01 (HandleRef pThis)
static internal int vtkAmoebaMinimizer_GetFunctionEvaluations_02 (HandleRef pThis)
static internal double vtkAmoebaMinimizer_GetFunctionValue_03 (HandleRef pThis)
static internal int vtkAmoebaMinimizer_GetIterations_04 (HandleRef pThis)
static internal int vtkAmoebaMinimizer_GetMaxIterations_05 (HandleRef pThis)
static internal int vtkAmoebaMinimizer_GetNumberOfParameters_06 (HandleRef pThis)
static internal IntPtr vtkAmoebaMinimizer_GetParameterName_07 (HandleRef pThis, int i)
static internal double vtkAmoebaMinimizer_GetParameterScale_08 (HandleRef pThis, string name)
static internal double vtkAmoebaMinimizer_GetParameterScale_09 (HandleRef pThis, int i)
static internal double vtkAmoebaMinimizer_GetParameterValue_10 (HandleRef pThis, string name)
static internal double vtkAmoebaMinimizer_GetParameterValue_11 (HandleRef pThis, int i)
static internal double vtkAmoebaMinimizer_GetTolerance_12 (HandleRef pThis)
static internal void vtkAmoebaMinimizer_Initialize_13 (HandleRef pThis)
static internal int vtkAmoebaMinimizer_IsA_14 (HandleRef pThis, string type)
static internal int vtkAmoebaMinimizer_IsTypeOf_15 (string type)
static internal int vtkAmoebaMinimizer_Iterate_16 (HandleRef pThis)
static internal void vtkAmoebaMinimizer_Minimize_17 (HandleRef pThis)
static internal IntPtr vtkAmoebaMinimizer_NewInstance_19 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkAmoebaMinimizer_SafeDownCast_20 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkAmoebaMinimizer_SetFunctionValue_21 (HandleRef pThis, double _arg)
static internal void vtkAmoebaMinimizer_SetMaxIterations_22 (HandleRef pThis, int _arg)
static internal void vtkAmoebaMinimizer_SetParameterScale_23 (HandleRef pThis, string name, double scale)
static internal void vtkAmoebaMinimizer_SetParameterScale_24 (HandleRef pThis, int i, double scale)
static internal void vtkAmoebaMinimizer_SetParameterValue_25 (HandleRef pThis, string name, double value)
static internal void vtkAmoebaMinimizer_SetParameterValue_26 (HandleRef pThis, int i, double value)
static internal void vtkAmoebaMinimizer_SetTolerance_27 (HandleRef pThis, double _arg)

Static Private Member Functions

static vtkAmoebaMinimizer ()
 Automatically generated type registration mechanics.

Detailed Description

vtkAmoebaMinimizer - nonlinear optimization with a simplex

Description vtkAmoebaMinimizer will modify a set of parameters in order to find the minimum of a specified function. The method used is commonly known as the amoeba method, it constructs an n-dimensional simplex in parameter space (i.e. a tetrahedron if the number or parameters is 3) and moves the vertices around parameter space until a local minimum is found. The amoeba method is robust, reasonably efficient, but is not guaranteed to find the global minimum if several local minima exist.


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

override void Kitware.VTK.vtkAmoebaMinimizer.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

Evaluate the function. This is usually called internally by the minimization code, but it is provided here as a public method.

Return the number of times that the function has been evaluated.

Get the function value resulting from the minimization.

Return the number of interations that have been performed. This is not necessarily the same as the number of function evaluations.

Specify the maximum number of iterations to try before giving up.

Get the number of parameters that have been set.

For completeness, an unchecked method to get the name for particular parameter (the result will be NULL if no name was set).

Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.

Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.

Get the value of a parameter at the current stage of the minimization. Call this method within the function that you are minimizing in order to get the current parameter values. It is preferable to specify parameters by name rather than by index.

Get the value of a parameter at the current stage of the minimization. Call this method within the function that you are minimizing in order to get the current parameter values. It is preferable to specify parameters by name rather than by index.

virtual double Kitware.VTK.vtkAmoebaMinimizer.GetTolerance ( ) [virtual]

Specify the fractional tolerance to aim for during the minimization.

Initialize the minimizer. This will reset the number of parameters to zero so that the minimizer can be reused.

override int Kitware.VTK.vtkAmoebaMinimizer.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkAmoebaMinimizer.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

virtual int Kitware.VTK.vtkAmoebaMinimizer.Iterate ( ) [virtual]

Perform one iteration of minimization. Returns zero if the tolerance stopping criterion has been met.

virtual void Kitware.VTK.vtkAmoebaMinimizer.Minimize ( ) [virtual]

Iterate until the minimum is found to within the specified tolerance, or until the MaxIterations has been reached.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkAmoebaMinimizer.SetFunctionValue ( double  _arg) [virtual]

Get the function value resulting from the minimization.

virtual void Kitware.VTK.vtkAmoebaMinimizer.SetMaxIterations ( int  _arg) [virtual]

Specify the maximum number of iterations to try before giving up.

void Kitware.VTK.vtkAmoebaMinimizer.SetParameterScale ( string  name,
double  scale 
)

Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.

void Kitware.VTK.vtkAmoebaMinimizer.SetParameterScale ( int  i,
double  scale 
)

Set the scale to use when modifying a parameter, i.e. the initial amount by which the parameter will be modified during the search for the minimum. It is preferable to identify scalars by name rather than by number.

void Kitware.VTK.vtkAmoebaMinimizer.SetParameterValue ( string  name,
double  value 
)

Set the initial value for the specified parameter. Calling this function for any parameter will reset the Iterations and the FunctionEvaluations counts to zero. You must also use SetParameterScale() to specify the step size by which the parameter will be modified during the minimization. It is preferable to specify parameters by name, rather than by number.

void Kitware.VTK.vtkAmoebaMinimizer.SetParameterValue ( int  i,
double  value 
)

Set the initial value for the specified parameter. Calling this function for any parameter will reset the Iterations and the FunctionEvaluations counts to zero. You must also use SetParameterScale() to specify the step size by which the parameter will be modified during the minimization. It is preferable to specify parameters by name, rather than by number.

virtual void Kitware.VTK.vtkAmoebaMinimizer.SetTolerance ( double  _arg) [virtual]

Specify the fractional tolerance to aim for during the minimization.

static internal void Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_EvaluateFunction_01 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetFunctionEvaluations_02 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetFunctionValue_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetIterations_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetMaxIterations_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetNumberOfParameters_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetParameterName_07 ( HandleRef  pThis,
int  i 
) [private]
static internal double Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetParameterScale_08 ( HandleRef  pThis,
string  name 
) [private]
static internal double Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetParameterScale_09 ( HandleRef  pThis,
int  i 
) [private]
static internal double Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetParameterValue_10 ( HandleRef  pThis,
string  name 
) [private]
static internal double Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetParameterValue_11 ( HandleRef  pThis,
int  i 
) [private]
static internal double Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_GetTolerance_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_Initialize_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_IsA_14 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_IsTypeOf_15 ( string  type) [private]
static internal int Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_Iterate_16 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_Minimize_17 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_NewInstance_19 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_SafeDownCast_20 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_SetFunctionValue_21 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_SetMaxIterations_22 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_SetParameterScale_23 ( HandleRef  pThis,
string  name,
double  scale 
) [private]
static internal void Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_SetParameterScale_24 ( HandleRef  pThis,
int  i,
double  scale 
) [private]
static internal void Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_SetParameterValue_25 ( HandleRef  pThis,
string  name,
double  value 
) [private]
static internal void Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_SetParameterValue_26 ( HandleRef  pThis,
int  i,
double  value 
) [private]
static internal void Kitware.VTK.vtkAmoebaMinimizer.vtkAmoebaMinimizer_SetTolerance_27 ( HandleRef  pThis,
double  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkAmoebaMinimizer.MRClassNameKey = "18vtkAmoebaMinimizer" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkAmoebaMinimizer.MRFullTypeName = "Kitware.VTK.vtkAmoebaMinimizer"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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