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 package org.apache.commons.math4.legacy.ode.sampling;
19
20
21 /** {@link StepNormalizer Step normalizer} modes. Determines how the step size
22 * is interpreted.
23 * @see FieldStepNormalizer
24 * @see StepNormalizer
25 * @see StepNormalizerBounds
26 * @since 3.0
27 */
28 public enum StepNormalizerMode {
29 /**
30 * Steps are fixed increments of the start value. In other words, they
31 * are relative to the start value.
32 *
33 * <p>If the integration start time is t0, then the points handled by
34 * the underlying fixed step size step handler are t0 (depending on
35 * the {@link StepNormalizerBounds bounds settings}), t0+h, t0+2h, ...</p>
36 *
37 * <p>If the integration range is an integer multiple of the step size
38 * (h), then the last point handled will be the end point of the
39 * integration (tend). If not, the last point may be the end point
40 * tend, or it may be a point belonging to the interval [tend - h ;
41 * tend], depending on the {@link StepNormalizerBounds bounds settings}.
42 * </p>
43 *
44 * @see StepNormalizer
45 * @see StepNormalizerBounds
46 */
47 INCREMENT,
48
49 /** Steps are multiples of a fixed value. In other words, they are
50 * relative to the first multiple of the step size that is encountered
51 * after the start value.
52 *
53 * <p>If the integration start time is t0, and the first multiple of
54 * the fixed step size that is encountered is t1, then the points
55 * handled by the underlying fixed step size step handler are t0
56 * (depending on the {@link StepNormalizerBounds bounds settings}), t1,
57 * t1+h, t1+2h, ...</p>
58 *
59 * <p>If the end point of the integration range (tend) is an integer
60 * multiple of the step size (h) added to t1, then the last point
61 * handled will be the end point of the integration (tend). If not,
62 * the last point may be the end point tend, or it may be a point
63 * belonging to the interval [tend - h ; tend], depending on the
64 * {@link StepNormalizerBounds bounds settings}.</p>
65 *
66 * @see StepNormalizer
67 * @see StepNormalizerBounds
68 */
69 MULTIPLES;
70 }