Dokumentacja klasy ProblemBase

#include <ProblemBase.h>

Diagram dziedziczenia dla ProblemBase

LinearProblem UnconstrainedProblem ProblemWithPenalty Lista wszystkich składowych.

Opis szczegółowy

Bazowa klasa dla zadań optymalizacji.

Zadanie, oprócz danych opisowych (nazwa, opis), posiada zmienne (w tym ilość wymiarów funkcji) oraz funkcję celu.

Rodzaj funkcji i/lub ew. ograniczeń jest określany przez klasy pochodne.

Każda klasa pochodna powinna tworzyć i rejestrować swój prototyp (patrz: konstruktor), aby była dostępna w reszcie programu.


Metody publiczne

 ProblemBase (std::auto_ptr< const FunctionBase > apFunction, std::auto_ptr< VariableNames > apVariables)
 Konstruktor.
virtual ~ProblemBase (void)
 Destruktor.
virtual std::auto_ptr< ResultStartSolve () const throw (OptimizationError)
 Znajduje rozwiązanie zadania optymalizacji.
virtual std::auto_ptr< ProblemBaseClone () const =0
 Tworzy nowy problem tej samej klasy.
virtual wxString ToString () const =0
 Tworzy tekstowy opis obiektu.
void SetMethod (std::auto_ptr< const Method > apMethod)
 Ustawia metodę.
void SetMethod (std::auto_ptr< Method > apMethod)
 Ustawia metodę.
virtual void SetFunction (auto_ptr< FunctionBase > cpFunction, auto_ptr< VariableNames > cpVariables)
 Ustawia nową bieżącą funkcję celu oraz zmienne.
const MethodUsedMethod () const
 Zwraca używaną metodę optymalizacji.
const FunctionBaseFunction () const
 Zwraca funkcję celu.
virtual const FunctionBaseBaseFunction () const
 Zwraca oryginalną funkcję celu.
const VariableNamesVariables () const
 Zwraca zmienne funkcji celu.
int VariableCount () const
 Zwraca liczbę zmiennych.
virtual wxString Name () const =0
 Zwraca nazwę problemu.
virtual ProblemIdType Id () const =0
 Zwraca ID problemu.

Statyczne metody publiczne

static const vector< ProblemBase * > & Problems ()
 Zwraca wektor problemów.
static ProblemBaseGetById (ProblemIdType id)
 Znajduje problem wg ID i zwraca wskaźnik na niego.
static ProblemIdType ClassId ()
 Zwraca ID problemu.

Metody chronione

 ProblemBase (bool doRegister=false)
 Konstruktor domyślny.
 ProblemBase (const ProblemBase &from)
 Konstruktor kopiujący.

Statyczne metody chronione

static ProblemIdType GenerateId ()
 Generuje unikalne ID.

Atrybuty chronione

CountedPtr< const FunctionBasemcpFunction
 Funkcja celu.
CountedPtr< const VariableNamesmcpVariables
 Zmienne funkcji celu.
std::auto_ptr< const MethodmapMethod
 Metoda.

Przyjaciele

class FunctionValidator


Dokumentacja konstruktora i destruktora

ProblemBase::ProblemBase std::auto_ptr< const FunctionBase apFunction,
std::auto_ptr< VariableNames apVariables
 

Konstruktor.

Parametry:
apFunction auto_ptr na funkcję celu.
apVariables auto_ptr na zmienne.

ProblemBase::ProblemBase bool  doRegister = false  )  [protected]
 

Konstruktor domyślny.

Parametry:
doRegister Czy zarejestrowac problem jako prototyp.


Dokumentacja funkcji składowych

const FunctionBase & ProblemBase::BaseFunction  )  const [virtual]
 

Zwraca oryginalną funkcję celu.

Funkcja zwraca oryginalną funkcję celu bez uwzględnienia ewentualnej kary.

Zwraca:
Referencja na oryginalną funkcję celu.

Reimplementowana w ProblemWithPenalty.

ProblemIdType ProblemBase::ClassId  )  [static]
 

Zwraca ID problemu.

Przykład: auto_ptr<ProblemBase> ap_problem(ProblemBase::GetById(LinearProblem::ClassId()));

Reimplementowana w LinearProblem, ProblemWithPenalty i UnconstrainedProblem.

const FunctionBase & ProblemBase::Function  )  const
 

Zwraca funkcję celu.

Zwraca:
Referencja na funkcję celu.

void ProblemBase::SetFunction auto_ptr< FunctionBase cpFunction,
auto_ptr< VariableNames cpVariables
[virtual]
 

Ustawia nową bieżącą funkcję celu oraz zmienne.

Parametry:
cpFunction CountedPtr na funkcję celu.
cpVariables CountedPtr na zmienne funkcji.

Reimplementowana w ProblemWithPenalty.

void ProblemBase::SetMethod std::auto_ptr< Method apMethod  ) 
 

Ustawia metodę.

Wcześniej ustawiona metoda jest usuwana. Metoda nie jest zmieniana wewnątrz problemu, ta wersja SetMethod dodaje const.

Parametry:
apMethod auto_ptr na nową metodę.

void ProblemBase::SetMethod std::auto_ptr< const Method apMethod  ) 
 

Ustawia metodę.

Wcześniej ustawiona metoda jest usuwana.

Parametry:
apMethod auto_ptr na nową metodę.

std::auto_ptr< Result > ProblemBase::StartSolve  )  const throw (OptimizationError) [virtual]
 

Znajduje rozwiązanie zadania optymalizacji.

Przed rozpoczęciem zeruje licznik wyliczeń funkcji, po zakończeniu umieszcza jego wartość w wyniku.

const VariableNames & ProblemBase::Variables  )  const
 

Zwraca zmienne funkcji celu.

Zwraca:
Referencja na zmienne.


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