← Back to branch summary

~ubuntu-branches/ubuntu/maverick/commons-math/maverick

« back to all changes in this revision

Viewing changes to src/main/java/org/apache/commons/math/ode/sampling/StepHandler.java

  • Committer: Bazaar Package Importer
  • Author(s): Damien Raude-Morvan
  • Date: 2010-04-05 23:33:02 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20100405233302-gpqlceked76nw28a
Tags: 2.1-1
* New upstream release.
* Bump Standards-Version to 3.8.4: no changes needed
* Bump debhelper to >= 7
* Switch to 3.0 (quilt) source format:
  - Remove B-D on quilt
  - Add d/source/format
  - Remove d/README.source

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/main/java/org/apache/commons/math/ode/sampling/StepHandler.java
17
17
 
18
18
package org.apache.commons.math.ode.sampling;
19
19
 
20
 
import org.apache.commons.math.ode.ContinuousOutputModel;
21
20
import org.apache.commons.math.ode.DerivativeException;
22
 
import org.apache.commons.math.ode.FirstOrderIntegrator;
23
 
import org.apache.commons.math.ode.SecondOrderIntegrator;
24
21
 
25
22
/**
26
23
 * This interface represents a handler that should be called after
35
32
 * last one, store the points in an ephemeris, or forward them to
36
33
 * specialized processing or output methods.</p>
37
34
 *
38
 
 * @see FirstOrderIntegrator
39
 
 * @see SecondOrderIntegrator
 
35
 * @see org.apache.commons.math.ode.FirstOrderIntegrator
 
36
 * @see org.apache.commons.math.ode.SecondOrderIntegrator
40
37
 * @see StepInterpolator
41
 
 * @version $Revision: 786881 $ $Date: 2009-06-20 14:53:08 -0400 (Sat, 20 Jun 2009) $
 
38
 * @version $Revision: 811786 $ $Date: 2009-09-06 05:36:08 -0400 (Sun, 06 Sep 2009) $
42
39
 * @since 1.2
43
40
 */
44
41
 
52
49
   * than a custom interpolator.</p>
53
50
   * @return true if the handler needs dense output
54
51
   */
55
 
  public boolean requiresDenseOutput();
 
52
  boolean requiresDenseOutput();
56
53
 
57
54
  /** Reset the step handler.
58
55
   * Initialize the internal data as required before the first step is
59
56
   * handled.
60
57
   */
61
 
  public void reset();
 
58
  void reset();
62
59
 
63
60
  /**
64
61
   * Handle the last accepted step
67
64
   * object on each call, so if the instance wants to keep it across
68
65
   * all calls (for example to provide at the end of the integration a
69
66
   * continuous model valid throughout the integration range, as the
70
 
   * {@link ContinuousOutputModel ContinuousOutputModel} class does),
71
 
   * it should build a local copy using the clone method of the
72
 
   * interpolator and store this copy. Keeping only a reference to the
73
 
   * interpolator and reusing it will result in unpredictable
74
 
   * behaviour (potentially crashing the application).
 
67
   * {@link org.apache.commons.math.ode.ContinuousOutputModel
 
68
   * ContinuousOutputModel} class does), it should build a local copy
 
69
   * using the clone method of the interpolator and store this copy.
 
70
   * Keeping only a reference to the interpolator and reusing it will
 
71
   * result in unpredictable behavior (potentially crashing the application).
75
72
   * @param isLast true if the step is the last one
76
73
   * @throws DerivativeException this exception is propagated to the
77
74
   * caller if the underlying user function triggers one
78
75
   */
79
 
  public void handleStep(StepInterpolator interpolator, boolean isLast)
80
 
    throws DerivativeException;
81
 
    
 
76
  void handleStep(StepInterpolator interpolator, boolean isLast) throws DerivativeException;
 
77
 
82
78
}