Dokumentacja klasy StandardStopCondition

#include <StandardStopCondition.h>

Diagram dziedziczenia dla StandardStopCondition

CustomValueCondition DistanceCondition SlopeCondition SquaredCustomValueCondition ValueCondition Lista wszystkich składowych.

Opis szczegółowy

Podstawowy warunek stopu.

Reprezentuje warunek stopu, który jest sprawdzany na podstawie dwóch ostatnich kroków metody (ich pozycji i/lub wartości funkcji).

Udostępnia metody IsMet, które sprawdzają, czy warunek jest spełniony dla zadanej wartości epsilon oraz podanych punktów i/lub wartości funkcji w poprzednim oraz bierzącym kroku.

W miarę możliwości (tzn. jeśli znane są wartości funkcji w momencie wywołania) należy stosować metodę IsMet z jak największą liczbą argumentów (nie licząc przekazywanej funkcji celu). Dzięki temu w niektórych przypadkach można ograniczyć liczbę obliczeń funkcji celu.


Metody publiczne

 StandardStopCondition (void)
 Konstruktor domyślny.
 StandardStopCondition (const DoubleParameter epsilon)
 Konstruktor.
 StandardStopCondition (const StandardStopCondition &from)
 Konstruktor kopiujący.
virtual ~StandardStopCondition (void)
 Destruktor.
virtual DoubleParameter Epsilon () const
 Zwraca wartość minimalną epsilon.
virtual DoubleParameterrEpsilon ()
 Zwraca referencję na epsilon.
virtual bool IsMet (const ColumnVector &previousPoint, const ColumnVector &lastPoint, double previousValue, double lastValue, double customValue=0) const =0
 Sprawdź warunek stopu.
virtual bool IsMet (const ColumnVector &previousPoint, const ColumnVector &lastPoint, double previousValue, const FunctionBase &function, double customValue=0) const =0
 Sprawdź warunek stopu.
virtual bool IsMet (const ColumnVector &previousPoint, const ColumnVector &lastPoint, const FunctionBase &function, double customValue=0) const =0
 Sprawdź warunek stopu.

Atrybuty chronione

DoubleParameter mEpsilon


Dokumentacja konstruktora i destruktora

StandardStopCondition::StandardStopCondition const DoubleParameter  epsilon  ) 
 

Konstruktor.

Parametry:
epsilon Dokładność.

StandardStopCondition::StandardStopCondition const StandardStopCondition from  ) 
 

Konstruktor kopiujący.

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


Dokumentacja funkcji składowych

virtual bool StandardStopCondition::IsMet const ColumnVector &  previousPoint,
const ColumnVector &  lastPoint,
const FunctionBase function,
double  customValue = 0
const [pure virtual]
 

Sprawdź warunek stopu.

Analogiczne, jak czteroargumentowy IsMet, z tą różnicą, że jeśli potrzebne są wartości funkcji w poprzednim bieżącym kroku, to są one obliczane na podstawie previousPoint i lastPoint. Jeśli jedna lub obie są znane, to należy korzystać z metody trzy- lub czteroargumentowej, pozwala to oszczędzić wyliczenia funkcji w niektórych przypadkach.

Parametry:
previousPoint Punkt wyznaczony w poprzednim kroku.
lastPoint Punkt wyznaczony w ostatnim kroku.
function Funkcja celu.
customValue Dodatkowy parametr porównywany bezpośrednio z epsilonem,
Zwraca:
Czy warunek stopu jest spełniony.

Implementowany w CustomValueCondition, DistanceCondition, SlopeCondition, SquaredCustomValueCondition i ValueCondition.

virtual bool StandardStopCondition::IsMet const ColumnVector &  previousPoint,
const ColumnVector &  lastPoint,
double  previousValue,
const FunctionBase function,
double  customValue = 0
const [pure virtual]
 

Sprawdź warunek stopu.

Analogiczne, jak czteroargumentowy IsMet, z tą różnicą, że jeśli potrzebna jest wartość funkcji w bieżącym kroku, to jest ona obliczana na podstawie lastPoint. Jeśli jest ona znana, to należy korzystać z metody czteroargumentowej, pozwala to oszczędzić jedno wyliczenie funkcji w niektórych przypadkach.

Parametry:
previousPoint Punkt wyznaczony w poprzednim kroku.
lastPoint Punkt wyznaczony w ostatnim kroku.
previousValue Wartość funkcji w poprzednim kroku.
function Funkcja celu.
customValue Dodatkowy parametr porównywany bezpośrednio z epsilonem,
Zwraca:
Czy warunek stopu jest spełniony.

Implementowany w CustomValueCondition, DistanceCondition, SlopeCondition, SquaredCustomValueCondition i ValueCondition.

virtual bool StandardStopCondition::IsMet const ColumnVector &  previousPoint,
const ColumnVector &  lastPoint,
double  previousValue,
double  lastValue,
double  customValue = 0
const [pure virtual]
 

Sprawdź warunek stopu.

Parametry:
previousPoint Punkt wyznaczony w poprzednim kroku.
lastPoint Punkt wyznaczony w ostatnim kroku.
previousValue Wartość funkcji w poprzednim kroku.
lastValue Wartość funkcji w tym kroku.
customValue Dodatkowy parametr porównywany bezpośrednio z epsilonem,
Zwraca:
Czy warunek stopu jest spełniony.

Implementowany w CustomValueCondition, DistanceCondition, SlopeCondition, SquaredCustomValueCondition i ValueCondition.


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