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