Dokumentacja klasy CustomValueCondition

#include <CustomValueCondition.h>

Diagram dziedziczenia dla CustomValueCondition

StandardStopCondition Lista wszystkich składowych.

Opis szczegółowy

Warunek stopu oparty na podanej liczbie.

Sprawdza, czy podana liczba (może to być np. norma gradientu) jest mniejsza lub większa od wartości granicznej (epsilon).


Metody publiczne

 CustomValueCondition (void)
 Konstruktor domyślny.
 CustomValueCondition (const wxString &name, bool metWhenGreater=false)
 Konstruktor.
 CustomValueCondition (const DoubleParameter &epsilon, bool metWhenGreater=false)
 Konstruktor.
 CustomValueCondition (const CustomValueCondition &from)
 Konstruktor kopiujący.
 ~CustomValueCondition (void)
 Destruktor.
virtual std::auto_ptr< StopConditionBase > Clone () const
 Tworzy kopię obiektu.
virtual wxString ToString () const
 Zwraca tekstowy opis warunku stopu.
virtual bool IsMet (const ColumnVector &previousPoint, const ColumnVector &lastPoint, double previousValue, double lastValue, double customValue) const
 Sprawdź warunek stopu.
virtual bool IsMet (const ColumnVector &previousPoint, const ColumnVector &lastPoint, double previousValue, const FunctionBase &function, double customValue) const
 Sprawdź warunek stopu.
virtual bool IsMet (const ColumnVector &previousPoint, const ColumnVector &lastPoint, const FunctionBase &function, double customValue) const
 Sprawdź warunek stopu.


Dokumentacja konstruktora i destruktora

CustomValueCondition::CustomValueCondition const wxString &  name,
bool  metWhenGreater = false
 

Konstruktor.

Parametry:
name Nazwa sprawdzanego parametru.
metWhenGreater Informacja, czy warunek jest spełniony, gdy wartość jest większa niż epsilon (false - spełniony gdy mniejsza).

CustomValueCondition::CustomValueCondition const DoubleParameter epsilon,
bool  metWhenGreater = false
 

Konstruktor.

Parametry:
epsilon Dokładność.
metWhenGreater Informacja, czy warunek jest spełniony, gdy wartość jest większa niż epsilon (false - spełniony gdy mniejsza).

CustomValueCondition::CustomValueCondition const CustomValueCondition from  ) 
 

Konstruktor kopiujący.

Parametry:
from Obiekt, którego wartość jest kopiowana.


Dokumentacja funkcji składowych

bool CustomValueCondition::IsMet const ColumnVector &  previousPoint,
const ColumnVector &  lastPoint,
const FunctionBase function,
double  customValue
const [virtual]
 

Sprawdź warunek stopu.

Zobacz również:
StopCondition::IsMet

Implementuje StandardStopCondition.

bool CustomValueCondition::IsMet const ColumnVector &  previousPoint,
const ColumnVector &  lastPoint,
double  previousValue,
const FunctionBase function,
double  customValue
const [virtual]
 

Sprawdź warunek stopu.

Zobacz również:
StopCondition::IsMet

Implementuje StandardStopCondition.

bool CustomValueCondition::IsMet const ColumnVector &  previousPoint,
const ColumnVector &  lastPoint,
double  previousValue,
double  lastValue,
double  customValue
const [virtual]
 

Sprawdź warunek stopu.

Zobacz również:
StopCondition::IsMet

Implementuje StandardStopCondition.


Dokumentacja dla tej klasy została wygenerowana z plików:
Wygenerowano Fri Sep 29 21:04:50 2006 dla EduOptim2 programem  doxygen 1.4.6