Module: ppl/ppl Branch: master Commit: c098c056b375b809087be22be43abf29ee516d63 URL: http://www.cs.unipr.it/git/gitweb.cgi?p=ppl/ppl.git;a=commit;h=c098c056b375b... Author: Enea Zaffanella <zaffanella@cs.unipr.it> Date: Mon Apr 16 22:04:46 2012 +0200 Fixed a few copy&paste errors in documentation. --- .../parma_polyhedra_library/Linear_Expression.java | 4 +- .../Java/parma_polyhedra_library/MIP_Problem.java | 32 ++++++++++---------- .../Java/parma_polyhedra_library/PIP_Problem.java | 12 ++++---- .../Parma_Polyhedra_Library.java | 2 +- .../parma_polyhedra_library/Poly_Con_Relation.java | 2 +- .../parma_polyhedra_library/Poly_Gen_Relation.java | 2 +- 6 files changed, 27 insertions(+), 27 deletions(-) diff --git a/interfaces/Java/parma_polyhedra_library/Linear_Expression.java b/interfaces/Java/parma_polyhedra_library/Linear_Expression.java index 7421426..cddd765 100644 --- a/interfaces/Java/parma_polyhedra_library/Linear_Expression.java +++ b/interfaces/Java/parma_polyhedra_library/Linear_Expression.java @@ -64,11 +64,11 @@ public abstract class Linear_Expression implements Cloneable { //! Returns a string representation of \p this. public native String toString(); - //! Returns <CODE>true</CODE> if and only if \p *this is \f$0\f$. + //! Returns <CODE>true</CODE> if and only if \p this is \f$0\f$. public native boolean is_zero(); /*! \brief Returns <CODE>true</CODE> if and only if all the homogeneous - terms of \p *this are \f$0\f$. + terms of \p this are \f$0\f$. */ public native boolean all_homogeneous_terms_are_zero(); diff --git a/interfaces/Java/parma_polyhedra_library/MIP_Problem.java b/interfaces/Java/parma_polyhedra_library/MIP_Problem.java index 100a039..86aa387 100644 --- a/interfaces/Java/parma_polyhedra_library/MIP_Problem.java +++ b/interfaces/Java/parma_polyhedra_library/MIP_Problem.java @@ -68,7 +68,7 @@ public class MIP_Problem extends PPL_Object { \param dim The dimension of the vector space enclosing \p this. - \exception std::length_error + \exception Length_Error_Exception Thrown if \p dim exceeds <CODE>max_space_dimension()</CODE>. */ public MIP_Problem(long dim) { @@ -92,10 +92,10 @@ public class MIP_Problem extends PPL_Object { \param mode The optimization mode. - \exception std::length_error + \exception Length_Error_Exception Thrown if \p dim exceeds <CODE>max_space_dimension()</CODE>. - \exception std::invalid_argument + \exception Invalid_Argument_Exception Thrown if the constraint system contains any strict inequality or if the space dimension of the constraint system (resp., the objective function) is strictly greater than \p dim. @@ -178,7 +178,7 @@ public class MIP_Problem extends PPL_Object { \param m The number of dimensions to add. - \exception std::length_error + \exception Length_Error_Exception Thrown if adding \p m new space dimensions would cause the vector space to exceed dimension <CODE>max_space_dimension()</CODE>. @@ -191,7 +191,7 @@ public class MIP_Problem extends PPL_Object { Sets the variables whose indexes are in set \p i_vars to be integer space dimensions. - \exception std::invalid_argument + \exception Invalid_Argument_Exception Thrown if some index in \p i_vars does not correspond to a space dimension in \p this. */ @@ -200,7 +200,7 @@ public class MIP_Problem extends PPL_Object { /*! \brief Adds a copy of constraint \p c to the MIP problem. - \exception std::invalid_argument + \exception Invalid_Argument_Exception Thrown if the constraint \p c is a strict inequality or if its space dimension is strictly greater than the space dimension of \p this. */ @@ -209,16 +209,16 @@ public class MIP_Problem extends PPL_Object { /*! \brief Adds a copy of the constraints in \p cs to the MIP problem. - \exception std::invalid_argument + \exception Invalid_Argument_Exception Thrown if the constraint system \p cs contains any strict inequality or if its space dimension is strictly greater than the space dimension - of \p *this. + of \p this. */ public native void add_constraints(Constraint_System cs); //! Sets the objective function to \p obj. /*! - \exception std::invalid_argument + \exception Invalid_Argument_Exception Thrown if the space dimension of \p obj is strictly greater than the space dimension of \p this. */ @@ -232,7 +232,7 @@ public class MIP_Problem extends PPL_Object { //! \name Computing the Solution of the MIP_Problem /*@{*/ - //! Checks satisfiability of \p *this. + //! Checks satisfiability of \p this. /*! \return <CODE>true</CODE> if and only if the MIP problem is satisfiable. @@ -260,7 +260,7 @@ public class MIP_Problem extends PPL_Object { \param den On exit will contain the denominator of the evaluated value. - \exception std::invalid_argument + \exception Invalid_Argument_Exception Thrown if \p this and \p evaluating_point are dimension-incompatible or if the generator \p evaluating_point is not a point. */ @@ -268,16 +268,16 @@ public class MIP_Problem extends PPL_Object { Coefficient num, Coefficient den); - //! Returns a feasible point for \p *this, if it exists. + //! Returns a feasible point for \p this, if it exists. /*! - \exception std::domain_error + \exception Domain_Error_Exception Thrown if the MIP problem is not satisfiable. */ public native Generator feasible_point(); //! Returns an optimal point for \p this, if it exists. /*! - \exception std::domain_error + \exception Domain_Error_Exception Thrown if \p this doesn't not have an optimizing point, i.e., if the MIP problem is unbounded or not satisfiable. */ @@ -287,8 +287,8 @@ public class MIP_Problem extends PPL_Object { Sets \p num and \p den so that \f$\frac{num}{den}\f$ is the solution of the optimization problem. - \exception std::domain_error - Thrown if \p *this doesn't not have an optimizing point, i.e., + \exception Domain_Error_Exception + Thrown if \p this doesn't not have an optimizing point, i.e., if the MIP problem is unbounded or not satisfiable. */ public native void optimal_value(Coefficient num, Coefficient den); diff --git a/interfaces/Java/parma_polyhedra_library/PIP_Problem.java b/interfaces/Java/parma_polyhedra_library/PIP_Problem.java index 7c54831..ce7bd87 100644 --- a/interfaces/Java/parma_polyhedra_library/PIP_Problem.java +++ b/interfaces/Java/parma_polyhedra_library/PIP_Problem.java @@ -104,10 +104,10 @@ public class PIP_Problem extends PPL_Object { vector space is an optimal solution. \param dim - The dimension of the vector space enclosing \p *this + The dimension of the vector space enclosing \p this (optional argument with default value \f$0\f$). - \exception std::length_error + \exception Length_Error_Exception Thrown if \p dim exceeds <CODE>max_space_dimension()</CODE>. */ public PIP_Problem(long dim) { @@ -247,7 +247,7 @@ public class PIP_Problem extends PPL_Object { /*! \brief Adds a copy of constraint \p c to the PIP problem. - \exception std::invalid_argument + \exception Invalid_Argument_Exception Thrown if the constraint \p c is a strict inequality or if its space dimension is strictly greater than the space dimension of \p this. */ @@ -256,10 +256,10 @@ public class PIP_Problem extends PPL_Object { /*! \brief Adds a copy of the constraints in \p cs to the PIP problem. - \exception std::invalid_argument + \exception Invalid_Argument_Exception Thrown if the constraint system \p cs contains any strict inequality or if its space dimension is strictly greater than the space dimension - of \p *this. + of \p this. */ public native void add_constraints(Constraint_System cs); @@ -268,7 +268,7 @@ public class PIP_Problem extends PPL_Object { //! \name Computing the Solution of the PIP_Problem /*@{*/ - //! Checks satisfiability of \p *this. + //! Checks satisfiability of \p this. /*! \return <CODE>true</CODE> if and only if the PIP problem is satisfiable. diff --git a/interfaces/Java/parma_polyhedra_library/Parma_Polyhedra_Library.java b/interfaces/Java/parma_polyhedra_library/Parma_Polyhedra_Library.java index cab24fd..2e222b3 100644 --- a/interfaces/Java/parma_polyhedra_library/Parma_Polyhedra_Library.java +++ b/interfaces/Java/parma_polyhedra_library/Parma_Polyhedra_Library.java @@ -280,7 +280,7 @@ public class Parma_Polyhedra_Library { The scaling factor to be applied to \p unscaled_weight; it has to be non-negative. - \exception std::invalid_argument + \exception Invalid_Argument_Exception Thrown if the computation of the weight threshold exceeds the maximum allowed value. diff --git a/interfaces/Java/parma_polyhedra_library/Poly_Con_Relation.java b/interfaces/Java/parma_polyhedra_library/Poly_Con_Relation.java index 424ea0f..39a0bb7 100644 --- a/interfaces/Java/parma_polyhedra_library/Poly_Con_Relation.java +++ b/interfaces/Java/parma_polyhedra_library/Poly_Con_Relation.java @@ -81,7 +81,7 @@ public class Poly_Con_Relation { return new Poly_Con_Relation(Poly_Con_Relation.SATURATES); } - //! True if and only if \p *this implies \p y. + //! True if and only if \p this implies \p y. public boolean implies(Poly_Con_Relation y) { return (this.mask_value & y.mask_value) == y.mask_value; } diff --git a/interfaces/Java/parma_polyhedra_library/Poly_Gen_Relation.java b/interfaces/Java/parma_polyhedra_library/Poly_Gen_Relation.java index 92f5f70..a99d1ed 100644 --- a/interfaces/Java/parma_polyhedra_library/Poly_Gen_Relation.java +++ b/interfaces/Java/parma_polyhedra_library/Poly_Gen_Relation.java @@ -51,7 +51,7 @@ public class Poly_Gen_Relation { return new Poly_Gen_Relation(Poly_Gen_Relation.SUBSUMES); } - //! True if and only if \p *this implies \p y. + //! True if and only if \p this implies \p y. public boolean implies(Poly_Gen_Relation y) { return (this.mask_value & y.mask_value) == y.mask_value; }