Paradiseo-eo sources added

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f

trunk/paradiseo-eo/doc/latex/classeo_real_interval.tex

@@ -0,0 +1,118 @@
+\section{eo\-Real\-Interval Class Reference}
+\label{classeo_real_interval}\index{eoRealInterval@{eoRealInterval}}
+fully bounded eo\-Real\-Bound == interval  
+
+
+{\tt \#include $<$eo\-Real\-Bounds.h$>$}
+
+Inheritance diagram for eo\-Real\-Interval::\begin{figure}[H]
+\begin{center}
+\leavevmode
+\includegraphics[height=4cm]{classeo_real_interval}
+\end{center}
+\end{figure}
+\subsection*{Public Member Functions}
+\begin{CompactItemize}
+\item 
+{\bf eo\-Real\-Interval} (double \_\-min=0, double \_\-max=1)\label{classeo_real_interval_a1}
+
+\begin{CompactList}\small\item\em Simple bounds = minimum and maximum (allowed). \item\end{CompactList}\item 
+virtual double {\bf minimum} () const \label{classeo_real_interval_a2}
+
+\begin{CompactList}\small\item\em get minimum value ::exception if does not exist \item\end{CompactList}\item 
+virtual double {\bf maximum} () const \label{classeo_real_interval_a3}
+
+\begin{CompactList}\small\item\em get maximum value ::exception if does not exist \item\end{CompactList}\item 
+virtual double {\bf range} () const \label{classeo_real_interval_a4}
+
+\begin{CompactList}\small\item\em get range ::exception if unbounded \item\end{CompactList}\item 
+virtual bool {\bf is\-Bounded} (void) const \label{classeo_real_interval_a5}
+
+\begin{CompactList}\small\item\em Self-Test: true if $\ast$$\ast$$\ast$both$\ast$$\ast$$\ast$ a min and a max. \item\end{CompactList}\item 
+virtual bool {\bf has\-No\-Bound\-At\-All} (void) const \label{classeo_real_interval_a6}
+
+\begin{CompactList}\small\item\em Self-Test: true if no min $\ast$$\ast$$\ast$and$\ast$$\ast$$\ast$ no max hence no further need to test/truncate/fold anything. \item\end{CompactList}\item 
+virtual bool {\bf is\-Min\-Bounded} (void) const \label{classeo_real_interval_a7}
+
+\begin{CompactList}\small\item\em Self-Test: bounded from below??? \item\end{CompactList}\item 
+virtual bool {\bf is\-Max\-Bounded} (void) const \label{classeo_real_interval_a8}
+
+\begin{CompactList}\small\item\em Self-Test: bounded from above??? \item\end{CompactList}\item 
+virtual double {\bf uniform} ({\bf eo\-Rng} \&\_\-rng=eo::rng) const \label{classeo_real_interval_a9}
+
+\begin{CompactList}\small\item\em random generator of uniform numbers in bounds ::exception if unbounded \item\end{CompactList}\item 
+virtual bool {\bf is\-In\-Bounds} (double \_\-r) const \label{classeo_real_interval_a10}
+
+\begin{CompactList}\small\item\em Test on a value: is it in bounds? \item\end{CompactList}\item 
+virtual void {\bf folds\-In\-Bounds} (double \&\_\-r) const \label{classeo_real_interval_a11}
+
+\begin{CompactList}\small\item\em Put value back into bounds - by folding back and forth. \item\end{CompactList}\item 
+virtual void {\bf truncate} (double \&\_\-r) const \label{classeo_real_interval_a12}
+
+\begin{CompactList}\small\item\em Put value back into bounds - by truncating to a boundary value. \item\end{CompactList}\item 
+virtual void {\bf read\-From} (std::istream \&\_\-is)
+\begin{CompactList}\small\item\em Read object. \item\end{CompactList}\item 
+virtual void {\bf print\-On} (std::ostream \&\_\-os) const 
+\begin{CompactList}\small\item\em Write object. \item\end{CompactList}\item 
+virtual {\bf eo\-Real\-Bounds} $\ast$ {\bf dup} () const \label{classeo_real_interval_a15}
+
+\begin{CompactList}\small\item\em for memory managements - ugly \item\end{CompactList}\end{CompactItemize}
+\subsection*{Private Attributes}
+\begin{CompactItemize}
+\item 
+double {\bf rep\-Minimum}\label{classeo_real_interval_r0}
+
+\item 
+double {\bf rep\-Maximum}\label{classeo_real_interval_r1}
+
+\item 
+double {\bf rep\-Range}\label{classeo_real_interval_r2}
+
+\end{CompactItemize}
+
+
+\subsection{Detailed Description}
+fully bounded eo\-Real\-Bound == interval 
+
+
+
+Definition at line 199 of file eo\-Real\-Bounds.h.
+
+\subsection{Member Function Documentation}
+\index{eoRealInterval@{eo\-Real\-Interval}!readFrom@{readFrom}}
+\index{readFrom@{readFrom}!eoRealInterval@{eo\-Real\-Interval}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void eo\-Real\-Interval::read\-From (std::istream \& {\em \_\-is})\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classeo_real_interval_a13}
+
+
+Read object. 
+
+\begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em \_\-is}]A std::istream. but reading should not be done here, because of bound problems see {\bf eo\-Real\-Vector\-Bounds}{\rm (p.\,\pageref{classeo_real_vector_bounds})} \end{description}
+\end{Desc}
+
+
+Implements {\bf eo\-Persistent} {\rm (p.\,\pageref{classeo_persistent_a1})}.
+
+Definition at line 286 of file eo\-Real\-Bounds.h.\index{eoRealInterval@{eo\-Real\-Interval}!printOn@{printOn}}
+\index{printOn@{printOn}!eoRealInterval@{eo\-Real\-Interval}}
+\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void eo\-Real\-Interval::print\-On (std::ostream \& {\em \_\-os}) const\hspace{0.3cm}{\tt  [inline, virtual]}}\label{classeo_real_interval_a14}
+
+
+Write object. 
+
+It's called print\-On since it prints the object on a stream. \begin{Desc}
+\item[Parameters:]
+\begin{description}
+\item[{\em \_\-os}]A std::ostream. \end{description}
+\end{Desc}
+
+
+Implements {\bf eo\-Printable} {\rm (p.\,\pageref{classeo_printable_a1})}.
+
+Definition at line 295 of file eo\-Real\-Bounds.h.
+
+The documentation for this class was generated from the following file:\begin{CompactItemize}
+\item 
+eo\-Real\-Bounds.h\end{CompactItemize}