Author: luc
Date: Sun Jul 10 11:04:46 2011
New Revision: 1144825
URL: http://svn.apache.org/viewvc?rev=1144825&view=rev
Log:
improved javadoc
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/analysis/solvers/BaseUnivariateRealSolver.java
Modified:
commons/proper/math/trunk/src/main/java/org/apache/commons/math/analysis/solvers/BaseUnivariateRealSolver.java
URL:
http://svn.apache.org/viewvc/commons/proper/math/trunk/src/main/java/org/apache/commons/math/analysis/solvers/BaseUnivariateRealSolver.java?rev=1144825&r1=1144824&r2=1144825&view=diff
==============================================================================
---
commons/proper/math/trunk/src/main/java/org/apache/commons/math/analysis/solvers/BaseUnivariateRealSolver.java
(original)
+++
commons/proper/math/trunk/src/main/java/org/apache/commons/math/analysis/solvers/BaseUnivariateRealSolver.java
Sun Jul 10 11:04:46 2011
@@ -23,10 +23,17 @@ import org.apache.commons.math.analysis.
* Interface for (univariate real) rootfinding algorithms.
* Implementations will search for only one zero in the given interval.
*
+ * This class is not intended for use outside of the Apache Commons Math
+ * library, regular user should rely on more specific interfaces like
+ * {@link UnivariateRealSolver}, {link PolynomialSolver} or {@link
+ * DifferentiableUnivariateRealSolver}.
* @param <FUNC> Type of function to solve.
*
* @version $Id$
* @since 3.0
+ * @see UnivariateRealSolver
+ * @see PolynomialSolver
+ * @see DifferentiableUnivariateRealSolver
*/
public interface BaseUnivariateRealSolver<FUNC extends UnivariateRealFunction>
{
/**
