Java Doc for UnivariateRealSolver.java in  » Science » Apache-commons-math-1.1 » org » apache » commons » math » analysis » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Science » Apache commons math 1.1 » org.apache.commons.math.analysis 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.commons.math.analysis.UnivariateRealSolver

All known Subclasses:   org.apache.commons.math.analysis.UnivariateRealSolverImpl,
UnivariateRealSolver
public interface UnivariateRealSolver (Code)
Interface for (univariate real) rootfinding algorithms.

Implementations will search for only one zero in the given interval.
version:
   $Revision: 155427 $ $Date: 2005-02-26 06:11:52 -0700 (Sat, 26 Feb 2005) $





Method Summary
 doublegetAbsoluteAccuracy()
     Get the actual absolute accuracy.
 doublegetFunctionValueAccuracy()
     Get the actual function value accuracy.
 intgetIterationCount()
     Get the number of iterations in the last run of the solver.

This is mainly meant for testing purposes.

 intgetMaximalIterationCount()
     Get the upper limit for the number of iterations.
 doublegetRelativeAccuracy()
     Get the actual relative accuracy.
 doublegetResult()
     Get the result of the last run of the solver.
 voidresetAbsoluteAccuracy()
     Reset the absolute accuracy to the default.
 voidresetFunctionValueAccuracy()
     Reset the actual function accuracy to the default.
 voidresetMaximalIterationCount()
     Reset the upper limit for the number of iterations to the default.
 voidresetRelativeAccuracy()
     Reset the relative accuracy to the default.
 voidsetAbsoluteAccuracy(double accuracy)
     Set the absolute accuracy.

The default is usually choosen so that roots in the interval -10..-0.1 and +0.1..+10 can be found with a reasonable accuracy.

 voidsetFunctionValueAccuracy(double accuracy)
     Set the function value accuracy.

This is used to determine whan an evaluated function value or some other value which is used as divisor is zero.

This is a safety guard and it shouldn't be necesary to change this in general.
Parameters:
  accuracy - the accuracy.
throws:
  IllegalArgumentException - if the accuracy can't be achieved bythe solver or is otherwise deemed unreasonable.

 voidsetMaximalIterationCount(int count)
     Set the upper limit for the number of iterations.

Usually a high iteration count indicates convergence problems.

 voidsetRelativeAccuracy(double accuracy)
     Set the relative accuracy.

This is used to stop iterations if the absolute accuracy can't be achieved due to large values or short mantissa length.

If this should be the primary criterion for convergence rather then a safety measure, set the absolute accuracy to a ridiculously small value, like 1E-1000.
Parameters:
  accuracy - the relative accuracy.
throws:
  IllegalArgumentException - if the accuracy can't be achieved bythe solver or is otherwise deemed unreasonable.

 doublesolve(double min, double max)
     Solve for a zero root in the given interval. A solver may require that the interval brackets a single zero root.
Parameters:
  min - the lower bound for the interval.
Parameters:
  max - the upper bound for the interval.
 doublesolve(double min, double max, double startValue)
     Solve for a zero in the given interval, start at startValue.



Method Detail
getAbsoluteAccuracy
double getAbsoluteAccuracy()(Code)
Get the actual absolute accuracy. the accuracy



getFunctionValueAccuracy
double getFunctionValueAccuracy()(Code)
Get the actual function value accuracy. the accuracy



getIterationCount
int getIterationCount()(Code)
Get the number of iterations in the last run of the solver.

This is mainly meant for testing purposes. It may occasionally help track down performance problems: if the iteration count is notoriously high, check whether the function is evaluated properly, and whether another solver is more amenable to the problem. the last iteration count.
throws:
  IllegalStateException - if there is no result available, eitherbecause no result was yet computed or the last attempt failed.




getMaximalIterationCount
int getMaximalIterationCount()(Code)
Get the upper limit for the number of iterations. the actual upper limit



getRelativeAccuracy
double getRelativeAccuracy()(Code)
Get the actual relative accuracy. the accuracy



getResult
double getResult()(Code)
Get the result of the last run of the solver. the last result.
throws:
  IllegalStateException - if there is no result available, eitherbecause no result was yet computed or the last attempt failed.



resetAbsoluteAccuracy
void resetAbsoluteAccuracy()(Code)
Reset the absolute accuracy to the default.

The default value is provided by the solver implementation.




resetFunctionValueAccuracy
void resetFunctionValueAccuracy()(Code)
Reset the actual function accuracy to the default. The default value is provided by the solver implementation.



resetMaximalIterationCount
void resetMaximalIterationCount()(Code)
Reset the upper limit for the number of iterations to the default.

The default value is supplied by the solver implementation.
See Also:   UnivariateRealSolver.setMaximalIterationCount(int)




resetRelativeAccuracy
void resetRelativeAccuracy()(Code)
Reset the relative accuracy to the default. The default value is provided by the solver implementation.



setAbsoluteAccuracy
void setAbsoluteAccuracy(double accuracy)(Code)
Set the absolute accuracy.

The default is usually choosen so that roots in the interval -10..-0.1 and +0.1..+10 can be found with a reasonable accuracy. If the expected absolute value of your roots is of much smaller magnitude, set this to a smaller value.

Solvers are advised to do a plausibility check with the relative accuracy, but clients should not rely on this.
Parameters:
  accuracy - the accuracy.
throws:
  IllegalArgumentException - if the accuracy can't be achieved bythe solver or is otherwise deemed unreasonable.




setFunctionValueAccuracy
void setFunctionValueAccuracy(double accuracy)(Code)
Set the function value accuracy.

This is used to determine whan an evaluated function value or some other value which is used as divisor is zero.

This is a safety guard and it shouldn't be necesary to change this in general.
Parameters:
  accuracy - the accuracy.
throws:
  IllegalArgumentException - if the accuracy can't be achieved bythe solver or is otherwise deemed unreasonable.




setMaximalIterationCount
void setMaximalIterationCount(int count)(Code)
Set the upper limit for the number of iterations.

Usually a high iteration count indicates convergence problems. However, the "reasonable value" varies widely for different solvers. Users are advised to use the default value supplied by the solver.

A ConvergenceException will be thrown if this number is exceeded.
Parameters:
  count - maximum number of iterations




setRelativeAccuracy
void setRelativeAccuracy(double accuracy)(Code)
Set the relative accuracy.

This is used to stop iterations if the absolute accuracy can't be achieved due to large values or short mantissa length.

If this should be the primary criterion for convergence rather then a safety measure, set the absolute accuracy to a ridiculously small value, like 1E-1000.
Parameters:
  accuracy - the relative accuracy.
throws:
  IllegalArgumentException - if the accuracy can't be achieved bythe solver or is otherwise deemed unreasonable.




solve
double solve(double min, double max) throws ConvergenceException, FunctionEvaluationException(Code)
Solve for a zero root in the given interval. A solver may require that the interval brackets a single zero root.
Parameters:
  min - the lower bound for the interval.
Parameters:
  max - the upper bound for the interval. a value where the function is zero
throws:
  ConvergenceException - if the maximum iteration count is exceededor the solver detects convergence problems otherwise.
throws:
  FunctionEvaluationException - if an error occurs evaluating thefunction
throws:
  IllegalArgumentException - if min > max or the endpoints do notsatisfy the requirements specified by the solver



solve
double solve(double min, double max, double startValue) throws ConvergenceException, FunctionEvaluationException(Code)
Solve for a zero in the given interval, start at startValue. A solver may require that the interval brackets a single zero root.
Parameters:
  min - the lower bound for the interval.
Parameters:
  max - the upper bound for the interval.
Parameters:
  startValue - the start value to use a value where the function is zero
throws:
  ConvergenceException - if the maximum iteration count is exceededor the solver detects convergence problems otherwise.
throws:
  FunctionEvaluationException - if an error occurs evaluating thefunction
throws:
  IllegalArgumentException - if min > max or the arguments do notsatisfy the requirements specified by the solver



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.