Dokumentacja klasy Constraint

#include <Constraint.h>

Lista wszystkich składowych.


Opis szczegółowy

Ograniczenie.

Ograniczenia reprezentowane są w postaci (nie)równości, np.:

x^2 + y - 1 <= 0

Typ ograniczenia określa kierunek nierówności (bądź równość) a funkcja lewą stronę wyrażenia.


Typy publiczne

typedef vector< ConstraintContainer
 Typ do przechowywania ograniczeń.
enum  ConstraintType { EQUAL, LESS_EQUAL_THAN, GREATER_EQUAL_THAN }
 Typ ograniczenia. Więcej...

Metody publiczne

 Constraint (void)
 Konstruktor domyślny.
 Constraint (const Constraint &from)
 Konstruktor kopiujący.
 Constraint (std::auto_ptr< const FunctionBase > apFunction, ConstraintType type)
 Konstruktor.
virtual ~Constraint (void)
 Destruktor.
Constraintoperator= (const Constraint &from)
 Operator przypisania.
double Value (const ColumnVector &point) const
 Zwraca wartość ograniczenia w punkcie.
bool IsValid (const ColumnVector &point, bool includeBoundary=true, double tolerance=0.001) const
 Sprawdza, czy dany punkt spełnia ograniczenie.
Constraint DeepCopy () const
 Wykonuje kopię ograniczenia wraz ze sklonowaniem funkcji.
const FunctionBaseFunction () const
 Zwraca funkcję ograniczenia (lewą stronę).
const ConstraintType Type () const
 Zwraca typ ograniczenia.
wxString ToString (bool full=true) const
 Zwraca reprezentację tekstową ograniczenia.

Atrybuty chronione

CountedPtr< const FunctionBasemcpFunction
 Funkcja opisująca ograniczenie.
ConstraintType mType
 Typ ograniczenia.

Przyjaciele

class ConstraintDialog
 Okno dialogowe edycji ograniczenia.

Komponenty

class  ProblemSetter


Dokumentacja składowych wyliczanych

enum Constraint::ConstraintType
 

Typ ograniczenia.

Wartości wyliczeń:
EQUAL  równościowe (lewa strona = 0)
LESS_EQUAL_THAN  nierównościowe (lewa strona <= 0)
GREATER_EQUAL_THAN  nierównościowe (lewa strona >= 0)


Dokumentacja konstruktora i destruktora

Constraint::Constraint const Constraint from  ) 
 

Konstruktor kopiujący.

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

Constraint::Constraint std::auto_ptr< const FunctionBase apFunction,
ConstraintType  type
 

Konstruktor.

Parametry:
apFunction Funkcja definiująca ograniczenie.
type Typ ograniczenia.


Dokumentacja funkcji składowych

bool Constraint::IsValid const ColumnVector &  point,
bool  includeBoundary = true,
double  tolerance = 0.001
const
 

Sprawdza, czy dany punkt spełnia ograniczenie.

Parametry:
point Punkt, dla którego sprawdzany jest warunek.
tolerance Tolerancja mierzona w dopuszczalnym przekroczeniu zera przez wartość ograniczenia w danym punkcie.

Constraint & Constraint::operator= const Constraint from  ) 
 

Operator przypisania.

Parametry:
from Przypisywana wartość.
Zwraca:
Referencja do bieżącego obiektu.


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