aboutsummaryrefslogtreecommitdiffstats
path: root/src/libnoiseforjava/Interp.java
blob: 53ed56d9bf146696039cf3418e0537ed3a124278 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*
 * Copyright (C) 2003, 2004 Jason Bevins (original libnoise code)
 * Copyright  2010 Thomas J. Hodge (java port of libnoise)
 * 
 * This file is part of libnoiseforjava.
 * 
 * libnoiseforjava is a Java port of the C++ library libnoise, which may be found at 
 * http://libnoise.sourceforge.net/.  libnoise was developed by Jason Bevins, who may be 
 * contacted at jlbezigvins@gmzigail.com (for great email, take off every 'zig').
 * Porting to Java was done by Thomas Hodge, who may be contacted at
 * libnoisezagforjava@gzagmail.com (remove every 'zag').
 * 
 * libnoiseforjava is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 * 
 * libnoiseforjava is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * libnoiseforjava.  If not, see <http://www.gnu.org/licenses/>.
 * 
 */

package libnoiseforjava;

public class Interp
{
   
      /// Performs cubic interpolation between two values bound between two other
      /// values.
      ///
      /// @param n0 The value before the first value.
      /// @param n1 The first value.
      /// @param n2 The second value.
      /// @param n3 The value after the second value.
      /// @param a The alpha value.
      ///
      /// @returns The interpolated value.
      ///
      /// The alpha value should range from 0.0 to 1.0.  If the alpha value is
      /// 0.0, this function returns @a n1.  If the alpha value is 1.0, this
      /// function returns @a n2.
      public static double cubicInterp (double n0, double n1, double n2, double n3,
            double a)
      {
         double p = (n3 - n2) - (n0 - n1);
         double q = (n0 - n1) - p;
         double r = n2 - n0;
         double s = n1;
         return p * a * a * a + q * a * a + r * a + s;
      }

      /// Performs linear interpolation between two values.
      ///
      /// @param n0 The first value.
      /// @param n1 The second value.
      /// @param a The alpha value.
      ///
      /// @returns The interpolated value.
      ///
      /// The alpha value should range from 0.0 to 1.0.  If the alpha value is
      /// 0.0, this function returns @a n0.  If the alpha value is 1.0, this
      /// function returns @a n1.
      public static double linearInterp (double n0, double n1, double a)
      {
        return ((1.0 - a) * n0) + (a * n1);
      }

      /// Maps a value onto a cubic S-curve.
      ///
      /// @param a The value to map onto a cubic S-curve.
      ///
      /// @returns The mapped value.
      ///
      /// @a a should range from 0.0 to 1.0.
      ///
      /// The derivative of a cubic S-curve is zero at @a a = 0.0 and @a a =
      /// 1.0
      public static double SCurve3 (double a)
      {
        return (a * a * (3.0 - 2.0 * a));
      }

      /// Maps a value onto a quintic S-curve.
      ///
      /// @param a The value to map onto a quintic S-curve.
      ///
      /// @returns The mapped value.
      ///
      /// @a a should range from 0.0 to 1.0.
      ///
      /// The first derivative of a quintic S-curve is zero at @a a = 0.0 and
      /// @a a = 1.0
      ///
      /// The second derivative of a quintic S-curve is zero at @a a = 0.0 and
      /// @a a = 1.0
      static double SCurve5 (double a)
      {
        double a3 = a * a * a;
        double a4 = a3 * a;
        double a5 = a4 * a;
        return (6.0 * a5) - (15.0 * a4) + (10.0 * a3);
      }

}