[roboptim-commit] [SCM] roboptim branch, core, updated. a6c1e8dad3cfd49324f28ca39103bb7a5ea0d738
Status: Beta
Brought to you by:
flamiraux
From: Thomas M. <tho...@us...> - 2009-06-16 04:18:39
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "roboptim". The branch, core has been updated via a6c1e8dad3cfd49324f28ca39103bb7a5ea0d738 (commit) from 13fde339a65c8767f7d6ea2cfa9698da80fc662b (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit a6c1e8dad3cfd49324f28ca39103bb7a5ea0d738 Author: Thomas Moulard <tho...@gm...> Date: Tue Jun 16 13:16:23 2009 +0900 Add sections into Problem class. * include/roboptim/core/problem.hh: Here. Signed-off-by: Thomas Moulard <tho...@gm...> diff --git a/ChangeLog b/ChangeLog index ecfc57b..9a9b8d7 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2009-06-16 Thomas Moulard <tho...@gm...> + + Add sections into Problem class. + * include/roboptim/core/problem.hh: Here. + 2009-06-15 Thomas Moulard <tho...@gm...> Fix implementation. diff --git a/include/roboptim/core/problem.hh b/include/roboptim/core/problem.hh index 7c9a7c2..6a23f35 100644 --- a/include/roboptim/core/problem.hh +++ b/include/roboptim/core/problem.hh @@ -154,6 +154,9 @@ namespace roboptim /// \brief Scale vector. typedef std::vector<value_type> scales_t; + /// \name Constructors and destructors. + /// \{ + /// \pre costfunction \f$\mathbb{R}^n \rightarrow \mathbb{R}\f$ explicit Problem (const function_t&) throw (); @@ -166,10 +169,46 @@ namespace roboptim ~Problem () throw (); + /// \} + + + /// \name Cost function. + /// \{ + /// \brief Retrieve cost function. /// \return cost function const function_t& function () const throw (); + /// \brief Retrieve arguments bounds. + /// Arguments bounds define in which interval + /// each argument is valid. + /// \return arguments bounds + intervals_t& argumentBounds () throw (); + + /// \brief Retrieve arguments bounds. + /// Arguments bounds define in which interval + /// each argument is valid. + /// \return arguments bounds + const intervals_t& argumentBounds () const throw (); + + /// \brief Retrieve arguments scales. + /// Arguments scales define which scale is applied for + /// each argument. + /// \return arguments scales + scales_t& argumentScales () throw (); + + /// \brief Retrieve arguments scales. + /// Arguments scales define which scale is applied for + /// each argument. + /// \return arguments scales + const scales_t& argumentScales () const throw (); + + /// \} + + + /// \name Constraints. + /// \{ + /// \brief Retrieve constraints. /// \return constraints const constraints_t& constraints () const throw (); @@ -186,45 +225,30 @@ namespace roboptim value_type scale = 1.) throw (std::runtime_error); - /// \brief Set the initial guess. - /// \return reference on the initial guess - startingPoint_t& startingPoint () throw (); - - /// \brief Get the initial guess. - /// \return reference on the initial guess - const startingPoint_t& startingPoint () const throw (); - /// \brief Retrieve constraints bounds. /// \return constraints bounds const intervals_t& bounds () const throw (); - /// \brief Retrieve arguments bounds. - /// Arguments bounds define in which interval - /// each argument is valid. - /// \return arguments bounds - intervals_t& argumentBounds () throw (); - - /// \brief Retrieve arguments bounds. - /// Arguments bounds define in which interval - /// each argument is valid. - /// \return arguments bounds - const intervals_t& argumentBounds () const throw (); - /// \brief Retrieve constraints scales. /// \return constraints scales const scales_t& scales () const throw (); - /// \brief Retrieve arguments scales. - /// Arguments scales define which scale is applied for - /// each argument. - /// \return arguments scales - scales_t& argumentScales () throw (); + /// \} + + + /// \name Starting point (initial guess). + /// \{ + + /// \brief Set the initial guess. + /// \return reference on the initial guess + startingPoint_t& startingPoint () throw (); + + /// \brief Get the initial guess. + /// \return reference on the initial guess + const startingPoint_t& startingPoint () const throw (); + + /// \} - /// \brief Retrieve arguments scales. - /// Arguments scales define which scale is applied for - /// each argument. - /// \return arguments scales - const scales_t& argumentScales () const throw (); /// \brief Display the problem on the specified output stream. /// ----------------------------------------------------------------------- Summary of changes: ChangeLog | 5 ++ include/roboptim/core/problem.hh | 84 ++++++++++++++++++++++++------------- 2 files changed, 59 insertions(+), 30 deletions(-) hooks/post-receive -- roboptim |