Lean  $LEAN_TAG$
QuantConnect.Optimizer.Parameters.OptimizationParameterEnumerator< T > Class Template Referenceabstract

Enumerates all possible values for specific optimization parameter More...

Inheritance diagram for QuantConnect.Optimizer.Parameters.OptimizationParameterEnumerator< T >:
[legend]

Public Member Functions

void Dispose ()
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 
abstract bool MoveNext ()
 Advances the enumerator to the next element of the collection. More...
 
void Reset ()
 Sets the enumerator to its initial position, which is before the first element in the collection. More...
 

Protected Member Functions

 OptimizationParameterEnumerator (T optimizationParameter)
 

Protected Attributes

readonly T OptimizationParameter
 The target optimization parameter to enumerate More...
 
int Index = -1
 The current enumeration state More...
 

Properties

abstract string Current [get]
 Gets the element in the collection at the current position of the enumerator. More...
 

Detailed Description

Enumerates all possible values for specific optimization parameter

Type Constraints
T :OptimizationParameter 

Definition at line 24 of file OptimizationParameterEnumerator.cs.

Member Function Documentation

◆ Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Definition at line 56 of file OptimizationParameterEnumerator.cs.

◆ MoveNext()

abstract bool QuantConnect.Optimizer.Parameters.OptimizationParameterEnumerator< T >.MoveNext ( )
pure virtual

Advances the enumerator to the next element of the collection.

Returns
true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.
Exceptions
T:System.InvalidOperationExceptionThe collection was modified after the enumerator was created.

Implemented in QuantConnect.Optimizer.Parameters.OptimizationStepParameterEnumerator.

◆ Reset()

Sets the enumerator to its initial position, which is before the first element in the collection.

Exceptions
T:System.InvalidOperationExceptionThe collection was modified after the enumerator was created.

Definition at line 69 of file OptimizationParameterEnumerator.cs.

Member Data Documentation

◆ OptimizationParameter

The target optimization parameter to enumerate

Definition at line 29 of file OptimizationParameterEnumerator.cs.

◆ Index

The current enumeration state

Definition at line 34 of file OptimizationParameterEnumerator.cs.

Property Documentation

◆ Current

Gets the element in the collection at the current position of the enumerator.

Returns
The element in the collection at the current position of the enumerator.

Definition at line 45 of file OptimizationParameterEnumerator.cs.


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