source: src/main/java/agents/anac/y2019/harddealer/math3/ode/sampling/package-info.java

Last change on this file was 204, checked in by Katsuhide Fujita, 5 years ago

Fixed errors of ANAC2019 agents
  • Property svn:executable set to *
File size: 3.0 KB
Line 
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17/**
18 *
19 * <p>
20 * This package provides classes to handle sampling steps during
21 * Ordinary Differential Equations integration.
22 * </p>
23 *
24 * <p>
25 * In addition to computing the evolution of the state vector at some grid points, all
26 * ODE integrators also build up interpolation models of this evolution <em>inside</em> the
27 * last computed step. If users are interested in these interpolators, they can register a
28 * {@link agents.anac.y2019.harddealer.math3.ode.sampling.StepHandler StepHandler} instance using the
29 * {@link agents.anac.y2019.harddealer.math3.ode.FirstOrderIntegrator#addStepHandler addStepHandler}
30 * method which is supported by all integrators. The integrator will call this instance
31 * at the end of each accepted step and provide it the interpolator. The user can do
32 * whatever he wants with this interpolator, which computes both the state and its
33 * time-derivative. A typical use of step handler is to provide some output to monitor
34 * the integration process.
35 * </p>
36 *
37 * <p>
38 * In a sense, this is a kind of Inversion Of Control: rather than having the master
39 * application driving the slave integrator by providing the target end value for
40 * the free variable, we get a master integrator scheduling the free variable
41 * evolution and calling the slave application callbacks that were registered at
42 * configuration time.
43 * </p>
44 *
45 * <p>
46 * Since some integrators may use variable step size, the generic {@link
47 * agents.anac.y2019.harddealer.math3.ode.sampling.StepHandler StepHandler} interface can be called
48 * either at regular or irregular rate. This interface allows to navigate to any location
49 * within the last computed step, thanks to the provided {@link
50 * agents.anac.y2019.harddealer.math3.ode.sampling.StepInterpolator StepInterpolator} object.
51 * If regular output is desired (for example in order to write an ephemeris file), then
52 * the simpler {@link agents.anac.y2019.harddealer.math3.ode.sampling.FixedStepHandler FixedStepHandler}
53 * interface can be used. Objects implementing this interface should be wrapped within a
54 * {@link agents.anac.y2019.harddealer.math3.ode.sampling.StepNormalizer StepNormalizer} instance
55 * in order to be registered to the integrator.
56 * </p>
57 *
58 *
59 */
60package agents.anac.y2019.harddealer.math3.ode.sampling;
Note: See TracBrowser for help on using the repository browser.