Dokumentacja klasy Result

#include <Result.h>

Lista wszystkich składowych.


Opis szczegółowy

Wynik działania metody optymalizacji.

Wynik zawiera, oczywiście, punkt, który metoda uznała za rozwiązanie problemu optymalizacji, oraz listę kolejnych iteracji.


Typy publiczne

typedef vector< CountedPtr<
const IterationData > > 
IterationContainer
 Kontener na iteracje.

Metody publiczne

 Result (unsigned firstIndex)
 Konstruktor.
virtual ~Result (void)
 Destruktor.
bool operator== (const Result &right) const
 Operator porównania.
virtual void Print (wxTextOutputStream &rOutput) const
 Drukuje wynik do strumienia tekstowego.
void AddIteration (auto_ptr< const IterationData > apIteration)
const ProblemBaseProblem () const
 Zwraca zadanie optymalizacji.
void SetProblem (std::auto_ptr< const ProblemBase > apProblem)
 Przekazuje zadanie optymalizacji do wyniku.
unsigned FirstIterationNumber () const
 Zwraca numer pierwszej iteracji.
unsigned LastIterationNumber () const
 Zwraca numer ostatniej iteracji.
const IterationContainerIterations () const
 Zwraca kontener iteracji.
const IterationDataIteration (unsigned number) const
 Zwraca iterację o podanym numerze.
unsigned IterationCount () const
 Zwraca liczbę iteracji.
const ColumnVector & FinalResult () const
 Zwraca wynik optymalizacji (tzn.
ColumnVector & rFinalResult ()
 Referencja na wynik optymalizacji.
unsigned EvaluationCount () const
 Zwraca liczbę wyliczeń wartości funkcji celu.
unsigned & rEvaluationCount ()
 Referencja na liczbę wyliczeń wartości funkcji celu.
void SetError (const wxString &message)
 Ustawia komunikat o błędzie oraz odp.
const wxString & ErrorMessage () const
 Zwraca komunikat o błędzie.
bool IsAborted () const
 Sprawdza, czy optymalizacja została przerwana (np.

Przyjaciele

wxTextOutputStream & operator<< (wxTextOutputStream &rOutput, const Result &result)
 Operator wypisywania do strumienia.


Dokumentacja konstruktora i destruktora

Result::Result unsigned  firstIndex  ) 
 

Konstruktor.

Parametry:
firstIndex Numer pierwszej iteracji, najczęsciej 1.


Dokumentacja funkcji składowych

const ColumnVector & Result::FinalResult  )  const
 

Zwraca wynik optymalizacji (tzn.

uzyskany punkt minimum).

Wynik jest zdefinowany tylko wtedy, gdy optymalizacja nie została przerwana wystąpieniem błedu.

Zobacz również:
IsAborted

unsigned Result::FirstIterationNumber  )  const
 

Zwraca numer pierwszej iteracji.

Najczęściej 1 albo 0.

bool Result::IsAborted  )  const
 

Sprawdza, czy optymalizacja została przerwana (np.

na skutek błędu obliczeń).

const IterationData & Result::Iteration unsigned  number  )  const
 

Zwraca iterację o podanym numerze.

Zobacz również:
FirstIterationNumber

unsigned Result::IterationCount  )  const
 

Zwraca liczbę iteracji.

Nie bierze pod uwagę iteracji zerowej, może więc być o 1 mniejsze od liczby obiektów iteracji w kontenerze.

bool Result::operator== const Result right  )  const
 

Operator porównania.

Porównywany jest tylko wynik, nie dodatkowe składowe (np. zadanie optymalizacji).

void Result::SetError const wxString &  message  ) 
 

Ustawia komunikat o błędzie oraz odp.

flagę.

Zobacz również:
IsAborted.


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