Author: tn
Date: Sun Sep 16 16:19:55 2012
New Revision: 1385307
URL: http://svn.apache.org/viewvc?rev=1385307&view=rev
Log:
Javadoc cleanup of linear optimization package.
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/AbstractLinearOptimizer.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearConstraint.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearObjectiveFunction.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearOptimizer.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/NoFeasibleSolutionException.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/Relationship.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/SimplexSolver.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/SimplexTableau.java
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/UnboundedSolutionException.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/AbstractLinearOptimizer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/AbstractLinearOptimizer.java?rev=1385307&r1=1385306&r2=1385307&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/AbstractLinearOptimizer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/AbstractLinearOptimizer.java
Sun Sep 16 16:19:55 2012
@@ -27,11 +27,12 @@ import org.apache.commons.math3.optimiza
/**
* Base class for implementing linear optimizers.
- * <p>This base class handles the boilerplate methods associated to thresholds
- * settings and iterations counters.</p>
+ * <p>
+ * This base class handles the boilerplate methods associated to thresholds
+ * settings and iterations counters.
+ *
* @version $Id$
* @since 2.0
- *
*/
public abstract class AbstractLinearOptimizer implements LinearOptimizer {
@@ -68,7 +69,8 @@ public abstract class AbstractLinearOpti
/** Number of iterations already performed. */
private int iterations;
- /** Simple constructor with default settings.
+ /**
+ * Simple constructor with default settings.
* <p>The maximal number of evaluation is set to its default value.</p>
*/
protected AbstractLinearOptimizer() {
@@ -118,9 +120,9 @@ public abstract class AbstractLinearOpti
return iterations;
}
- /** Increment the iterations counter by 1.
- * @exception MaxCountExceededException if the maximal number
- * of iterations is exceeded
+ /**
+ * Increment the iterations counter by 1.
+ * @exception MaxCountExceededException if the maximal number of
iterations is exceeded
*/
protected void incrementIterationsCounter()
throws MaxCountExceededException {
@@ -131,9 +133,9 @@ public abstract class AbstractLinearOpti
/** {@inheritDoc} */
public PointValuePair optimize(final LinearObjectiveFunction f,
- final Collection<LinearConstraint>
constraints,
- final GoalType goalType, final boolean
restrictToNonNegative)
- throws MathIllegalStateException {
+ final Collection<LinearConstraint>
constraints,
+ final GoalType goalType, final boolean
restrictToNonNegative)
+ throws MathIllegalStateException {
// store linear problem characteristics
this.function = f;
@@ -148,12 +150,12 @@ public abstract class AbstractLinearOpti
}
- /** Perform the bulk of optimization algorithm.
+ /**
+ * Perform the bulk of optimization algorithm.
* @return the point/value pair giving the optimal value for objective
function
* @exception MathIllegalStateException if no solution fulfilling the
constraints
* can be found in the allowed number of iterations
*/
- protected abstract PointValuePair doOptimize()
- throws MathIllegalStateException;
+ protected abstract PointValuePair doOptimize() throws
MathIllegalStateException;
}
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearConstraint.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearConstraint.java?rev=1385307&r1=1385306&r2=1385307&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearConstraint.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearConstraint.java
Sun Sep 16 16:19:55 2012
@@ -184,7 +184,6 @@ public class LinearConstraint implements
return value;
}
- /** {@inheritDoc} */
@Override
public boolean equals(Object other) {
@@ -201,7 +200,6 @@ public class LinearConstraint implements
return false;
}
- /** {@inheritDoc} */
@Override
public int hashCode() {
return relationship.hashCode() ^
@@ -209,7 +207,8 @@ public class LinearConstraint implements
coefficients.hashCode();
}
- /** Serialize the instance.
+ /**
+ * Serialize the instance.
* @param oos stream where object should be written
* @throws IOException if object cannot be written to stream
*/
@@ -219,7 +218,8 @@ public class LinearConstraint implements
MatrixUtils.serializeRealVector(coefficients, oos);
}
- /** Deserialize the instance.
+ /**
+ * Deserialize the instance.
* @param ois stream from which the object should be read
* @throws ClassNotFoundException if a class in the stream cannot be found
* @throws IOException if object cannot be read from the stream
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearObjectiveFunction.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearObjectiveFunction.java?rev=1385307&r1=1385306&r2=1385307&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearObjectiveFunction.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearObjectiveFunction.java
Sun Sep 16 16:19:55 2012
@@ -101,7 +101,6 @@ public class LinearObjectiveFunction imp
return coefficients.dotProduct(point) + constantTerm;
}
- /** {@inheritDoc} */
@Override
public boolean equals(Object other) {
@@ -117,13 +116,13 @@ public class LinearObjectiveFunction imp
return false;
}
- /** {@inheritDoc} */
@Override
public int hashCode() {
return Double.valueOf(constantTerm).hashCode() ^
coefficients.hashCode();
}
- /** Serialize the instance.
+ /**
+ * Serialize the instance.
* @param oos stream where object should be written
* @throws IOException if object cannot be written to stream
*/
@@ -133,7 +132,8 @@ public class LinearObjectiveFunction imp
MatrixUtils.serializeRealVector(coefficients, oos);
}
- /** Deserialize the instance.
+ /**
+ * Deserialize the instance.
* @param ois stream from which the object should be read
* @throws ClassNotFoundException if a class in the stream cannot be found
* @throws IOException if object cannot be read from the stream
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearOptimizer.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearOptimizer.java?rev=1385307&r1=1385306&r2=1385307&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearOptimizer.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/LinearOptimizer.java
Sun Sep 16 16:19:55 2012
@@ -52,17 +52,20 @@ import org.apache.commons.math3.optimiza
*/
public interface LinearOptimizer {
- /** Set the maximal number of iterations of the algorithm.
+ /**
+ * Set the maximal number of iterations of the algorithm.
* @param maxIterations maximal number of function calls
*/
void setMaxIterations(int maxIterations);
- /** Get the maximal number of iterations of the algorithm.
+ /**
+ * Get the maximal number of iterations of the algorithm.
* @return maximal number of iterations
*/
int getMaxIterations();
- /** Get the number of iterations realized by the algorithm.
+ /**
+ * Get the number of iterations realized by the algorithm.
* <p>
* The number of evaluations corresponds to the last call to the
* {@link #optimize(LinearObjectiveFunction, Collection, GoalType,
boolean) optimize}
@@ -72,18 +75,17 @@ public interface LinearOptimizer {
*/
int getIterations();
- /** Optimizes an objective function.
+ /**
+ * Optimizes an objective function.
* @param f linear objective function
* @param constraints linear constraints
- * @param goalType type of optimization goal: either {@link
GoalType#MAXIMIZE}
- * or {@link GoalType#MINIMIZE}
+ * @param goalType type of optimization goal: either {@link
GoalType#MAXIMIZE} or {@link GoalType#MINIMIZE}
* @param restrictToNonNegative whether to restrict the variables to
non-negative values
* @return point/value pair giving the optimal value for objective function
* @exception MathIllegalStateException if no solution fulfilling the
constraints
- * can be found in the allowed number of iterations
+ * can be found in the allowed number of iterations
*/
PointValuePair optimize(LinearObjectiveFunction f,
Collection<LinearConstraint> constraints,
- GoalType goalType, boolean
restrictToNonNegative)
- throws MathIllegalStateException;
+ GoalType goalType, boolean
restrictToNonNegative) throws MathIllegalStateException;
}
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/NoFeasibleSolutionException.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/NoFeasibleSolutionException.java?rev=1385307&r1=1385306&r2=1385307&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/NoFeasibleSolutionException.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/NoFeasibleSolutionException.java
Sun Sep 16 16:19:55 2012
@@ -21,8 +21,8 @@ import org.apache.commons.math3.exceptio
import org.apache.commons.math3.exception.util.LocalizedFormats;
/**
- * This class represents exceptions thrown by optimizers when no solution
- * fulfills the constraints.
+ * This class represents exceptions thrown by optimizers when no solution
fulfills the constraints.
+ *
* @version $Id$
* @since 2.0
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/Relationship.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/Relationship.java?rev=1385307&r1=1385306&r2=1385307&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/Relationship.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/Relationship.java
Sun Sep 16 16:19:55 2012
@@ -43,7 +43,6 @@ public enum Relationship {
this.stringValue = stringValue;
}
- /** {@inheritDoc} */
@Override
public String toString() {
return stringValue;
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/SimplexSolver.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/SimplexSolver.java?rev=1385307&r1=1385306&r2=1385307&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/SimplexSolver.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/SimplexSolver.java
Sun Sep 16 16:19:55 2012
@@ -27,6 +27,7 @@ import org.apache.commons.math3.util.Pre
/**
* Solves a linear problem using the Two-Phase Simplex Method.
+ *
* @version $Id$
* @since 2.0
*/
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/SimplexTableau.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/SimplexTableau.java?rev=1385307&r1=1385306&r2=1385307&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/SimplexTableau.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/SimplexTableau.java
Sun Sep 16 16:19:55 2012
@@ -110,8 +110,7 @@ class SimplexTableau implements Serializ
* Build a tableau for a linear problem.
* @param f linear objective function
* @param constraints linear constraints
- * @param goalType type of optimization goal: either {@link
GoalType#MAXIMIZE}
- * or {@link GoalType#MINIMIZE}
+ * @param goalType type of optimization goal: either {@link
GoalType#MAXIMIZE} or {@link GoalType#MINIMIZE}
* @param restrictToNonNegative whether to restrict the variables to
non-negative values
* @param epsilon amount of error to accept when checking for optimality
*/
@@ -126,8 +125,7 @@ class SimplexTableau implements Serializ
* Build a tableau for a linear problem.
* @param f linear objective function
* @param constraints linear constraints
- * @param goalType type of optimization goal: either {@link
GoalType#MAXIMIZE}
- * or {@link GoalType#MINIMIZE}
+ * @param goalType type of optimization goal: either {@link
GoalType#MAXIMIZE} or {@link GoalType#MINIMIZE}
* @param restrictToNonNegative whether to restrict the variables to
non-negative values
* @param epsilon amount of error to accept when checking for optimality
* @param maxUlps amount of error to accept in floating point comparisons
@@ -397,7 +395,6 @@ class SimplexTableau implements Serializ
/**
* Get the current solution.
- *
* @return current solution
*/
protected PointValuePair getSolution() {
@@ -437,8 +434,8 @@ class SimplexTableau implements Serializ
* Subtracts a multiple of one row from another.
* <p>
* After application of this operation, the following will hold:
- * minuendRow = minuendRow - multiple * subtrahendRow
- * </p>
+ * <pre>minuendRow = minuendRow - multiple * subtrahendRow</pre>
+ *
* @param dividendRow index of the row
* @param divisor value of the divisor
*/
@@ -452,8 +449,8 @@ class SimplexTableau implements Serializ
* Subtracts a multiple of one row from another.
* <p>
* After application of this operation, the following will hold:
- * minuendRow = minuendRow - multiple * subtrahendRow
- * </p>
+ * <pre>minuendRow = minuendRow - multiple * subtrahendRow</pre>
+ *
* @param minuendRow row index
* @param subtrahendRow row index
* @param multiple multiplication factor
@@ -486,7 +483,8 @@ class SimplexTableau implements Serializ
return tableau.getRowDimension();
}
- /** Get an entry of the tableau.
+ /**
+ * Get an entry of the tableau.
* @param row row index
* @param column column index
* @return entry at (row, column)
@@ -495,7 +493,8 @@ class SimplexTableau implements Serializ
return tableau.getEntry(row, column);
}
- /** Set an entry of the tableau.
+ /**
+ * Set an entry of the tableau.
* @param row row index
* @param column column index
* @param value for the entry
@@ -532,10 +531,9 @@ class SimplexTableau implements Serializ
/**
* Get the number of decision variables.
* <p>
- * If variables are not restricted to positive values, this will include 1
- * extra decision variable to represent the absolute value of the most
- * negative variable.
- * </p>
+ * If variables are not restricted to positive values, this will include 1
extra decision variable to represent
+ * the absolute value of the most negative variable.
+ *
* @return number of decision variables
* @see #getOriginalNumDecisionVariables()
*/
@@ -576,7 +574,6 @@ class SimplexTableau implements Serializ
return tableau.getData();
}
- /** {@inheritDoc} */
@Override
public boolean equals(Object other) {
@@ -599,7 +596,6 @@ class SimplexTableau implements Serializ
return false;
}
- /** {@inheritDoc} */
@Override
public int hashCode() {
return Boolean.valueOf(restrictToNonNegative).hashCode() ^
@@ -613,7 +609,8 @@ class SimplexTableau implements Serializ
tableau.hashCode();
}
- /** Serialize the instance.
+ /**
+ * Serialize the instance.
* @param oos stream where object should be written
* @throws IOException if object cannot be written to stream
*/
@@ -623,7 +620,8 @@ class SimplexTableau implements Serializ
MatrixUtils.serializeRealMatrix(tableau, oos);
}
- /** Deserialize the instance.
+ /**
+ * Deserialize the instance.
* @param ois stream from which the object should be read
* @throws ClassNotFoundException if a class in the stream cannot be found
* @throws IOException if object cannot be read from the stream
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/UnboundedSolutionException.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/UnboundedSolutionException.java?rev=1385307&r1=1385306&r2=1385307&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/UnboundedSolutionException.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math3/optimization/linear/UnboundedSolutionException.java
Sun Sep 16 16:19:55 2012
@@ -21,8 +21,8 @@ import org.apache.commons.math3.exceptio
import org.apache.commons.math3.exception.util.LocalizedFormats;
/**
- * This class represents exceptions thrown by optimizers when a solution
- * escapes to infinity.
+ * This class represents exceptions thrown by optimizers when a solution
escapes to infinity.
+ *
* @version $Id$
* @since 2.0
*/
