Skip to content

Commit

Permalink
Interpolator: expanding documentation of Nearest and None. issue #71
Browse files Browse the repository at this point in the history
  • Loading branch information
nwolek committed Dec 30, 2015
1 parent 936be2f commit 8060df4
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions include/core/JamomaInterpolator.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,14 @@ namespace Jamoma {
};


/** No interpolation always returns the first sample passed to it */
/** No interpolation always returns the first sample passed to it
@param x0 Sample value that will be returned
@param x1 Unused sample value
@param x2 Unused sample value
@param x3 Unused sample value
@param delta Unused fractional location
@return The interpolated value.
*/
template<class T>
class None : Base {
public:
Expand All @@ -47,7 +54,16 @@ namespace Jamoma {
}
};

/** Nearest interpolation returns the closest sample by rounding the delta up or down. */
/** Nearest interpolation returns the closest sample by rounding the delta up or down.
@param x0 Returned sample value when rounding down
@param x1 Returned sample value when rounding up
@param x2 Unused sample value
@param x3 Unused sample value
@param delta Fractional location between x0 and x1 @n
delta < 0.5 => x0 @n
delta >= 0.5 => x1
@return The interpolated value.
*/
template<class T>
class Nearest : Base {
public:
Expand Down

0 comments on commit 8060df4

Please sign in to comment.