Dokumentacja klasy DoubleParameter

#include <DoubleParameter.h>

Lista wszystkich składowych.


Opis szczegółowy

Parametr o wartości zmiennoprzecinkowej i ograniczonym przedziale wartości.

Klasa przewidziana przede wszystkim dla parametrów metod optymalizacji. Dopuszczalne wartości są ograniczone do zadanego przedziału, który może być lewo- bądź prawostronnie otwarty albo zamknięty.


Metody publiczne

 DoubleParameter (double value=0.0, double min=-DBL_MAX, bool leftOpen=false, double max=DBL_MAX, bool rightOpen=false, bool integer=false) throw (Error)
 Konstruktor.
 DoubleParameter (const DoubleParameter &from) throw ()
 Konstruktor kopiujący.
 ~DoubleParameter (void)
 Destruktor.
DoubleParameteroperator= (const DoubleParameter &from) throw ()
 Operator przypisania.
DoubleParameteroperator= (double from) throw (Error)
 Operator przypisania.
 operator double () const throw ()
 Operator rzutowania.
wxString BoundaryToString () const
 Tworzy napis przedstawiający dopuszczalny przedział.
void SetLowerBoundary (double min, bool open=false)
 Ustawia dolną granicę przedziału dopuszczalnych wartości.
void SetUpperBoundary (double max, bool open=false)
 Ustawia górną granicę przedziału dopuszczalnych wartości.
void SetIntegerType (bool integer)
 Ustawia typ wartości na liczby całkowite lub dowolne.
bool IsValid (double value) const
 Sprawdza, czy wartość mieści się w dopuszczalnym przedziale.
bool HasIntegerType () const
 Podaje informację, czy wartość musi być liczbą całkowitą.


Dokumentacja konstruktora i destruktora

DoubleParameter::DoubleParameter double  value = 0.0,
double  min = -DBL_MAX,
bool  leftOpen = false,
double  max = DBL_MAX,
bool  rightOpen = false,
bool  integer = false
throw (Error)
 

Konstruktor.

Parametry:
value Wartość początkowa.
min Minimalna dopuszczalna wartość.
leftOpen Czy przedział otwarty z lewej strony.
max Maksymalna dopuszczalna wartość.
rightOpen Czy przedział otwarty z prawej strony.
integer Czy wartość musi być liczbą całkowitą.

DoubleParameter::DoubleParameter const DoubleParameter from  )  throw ()
 

Konstruktor kopiujący.

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


Dokumentacja funkcji składowych

wxString DoubleParameter::BoundaryToString  )  const
 

Tworzy napis przedstawiający dopuszczalny przedział.

Np. (0, 1]

DoubleParameter & DoubleParameter::operator= const DoubleParameter from  )  throw ()
 

Operator przypisania.

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

void DoubleParameter::SetIntegerType bool  integer  ) 
 

Ustawia typ wartości na liczby całkowite lub dowolne.

Parametry:
integer Czy wartość musi być liczbą całkowitą.

void DoubleParameter::SetLowerBoundary double  min,
bool  open = false
 

Ustawia dolną granicę przedziału dopuszczalnych wartości.

Parametry:
min Wartość.
open Czy przedział jest lewostronnie otwarty.

void DoubleParameter::SetUpperBoundary double  max,
bool  open = false
 

Ustawia górną granicę przedziału dopuszczalnych wartości.

Parametry:
max Wartość.
open Czy przedział jest prawostronnie otwarty.


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