Dokumentacja klasy SquaredCustomValueCondition

#include <SquaredCustomValueCondition.h>

Diagram dziedziczenia dla SquaredCustomValueCondition

StandardStopCondition Lista wszystkich składowych.

Opis szczegółowy

Warunek stopu oparty na kwadracie podanej liczby.

Sprawdza, czy kwadrat podanej liczby (może nią być np. norma gradientu) jest mniejszy lub większy od wartości granicznej (epsilon).


Metody publiczne

 SquaredCustomValueCondition (void)
 Konstruktor domyślny.
 SquaredCustomValueCondition (const wxString &name, bool metWhenGreater=false)
 Konstruktor.
 SquaredCustomValueCondition (const DoubleParameter &epsilon, bool metWhenGreater=false)
 Konstruktor.
 SquaredCustomValueCondition (const SquaredCustomValueCondition &from)
 Konstruktor kopiujący.
 ~SquaredCustomValueCondition (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

SquaredCustomValueCondition::SquaredCustomValueCondition 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).

SquaredCustomValueCondition::SquaredCustomValueCondition 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).

SquaredCustomValueCondition::SquaredCustomValueCondition const SquaredCustomValueCondition from  ) 
 

Konstruktor kopiujący.

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


Dokumentacja funkcji składowych

bool SquaredCustomValueCondition::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 SquaredCustomValueCondition::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 SquaredCustomValueCondition::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:54 2006 dla EduOptim2 programem  doxygen 1.4.6