Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Feature] Add exponential mapping, sinusoidal mapping, lerp, and curve function #69

Merged
merged 11 commits into from
Jul 10, 2024
Merged

[Feature] Add exponential mapping, sinusoidal mapping, lerp, and curve function #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
8fdc51b
feat: add curve function
hiikariri Apr 17, 2024
11d9ac5
fix: remove redudancy in clamping value for curve, clamp value in map…
hiikariri Apr 18, 2024
748ec64
feat: add exponentialmap and abs function
Mobilizes May 16, 2024
12f153a
feat: add sinusoidal mapping value
hiikariri May 23, 2024
7d35b99
Merge branch 'master' of github.com:ichiro-its/keisan into feature/up…
hiikariri May 29, 2024
6706443
Merge branch 'master' of github.com:ichiro-its/keisan into feature/up…
hiikariri May 29, 2024
1a25965
Merge branch 'feature/update-curve-function' of github.com:ichiro-its…
Mobilizes Jun 5, 2024
ce32155
feat: add unit tests
hiikariri Jun 6, 2024
bea4f2d
Merge branch 'feature/update-curve-function' of github.com:ichiro-its…
hiikariri Jun 6, 2024
2998007
fix: remove not used function, fix curve when min equal max
hiikariri Jun 23, 2024
1664c6d
feat: add lerp
hiikariri Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions include/keisan/number.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,16 @@ T map(
const T & value, const T & source_min, const T & source_max,
const T & target_min, const T & target_max);

template<typename T>
T exponentialmap(
const T & value, const T & source_min, const T & source_max,
const T & target_min, const T & target_max);

template<typename T>
T sinusoidalmap(
const T & value, const T & source_min, const T & source_max,
const T & target_min, const T & target_max);

template<typename T>
T clamp(const T & value, const T & min, const T & max);

Expand All @@ -64,6 +74,12 @@ T wrap(const T & value, const T & min, const T & max);
template<typename T>
T smooth(T value, T target, T ratio);

template<typename T>
T curve(const T & value, const T & min, const T & max, const T & exponential);

template<typename T>
T lerp(const T & start, const T & end, const T & rate);

} // namespace keisan

#include "keisan/number.impl.hpp"
Expand Down
42 changes: 42 additions & 0 deletions include/keisan/number.impl.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,32 @@ T map(
scale(source_val - source_min, source_max - source_min, target_max - target_min);
}

template<typename T>
T exponentialmap(
const T & value, const T & source_min, const T & source_max,
const T & target_min, const T & target_max)
{
auto source_val = value;
source_val = std::min(source_val, std::max(source_min, source_max));
source_val = std::max(source_val, std::min(source_min, source_max));
auto map_coeff = (target_min <= target_max) ? 1 : -1;
auto normalized_val = (source_val - source_min) / (source_max - source_min);
return map_coeff * std::pow(std::abs(target_max - target_min + map_coeff), normalized_val) + target_min - map_coeff;
}

template<typename T>
T sinusoidalmap(
const T & value, const T & source_min, const T & source_max,
const T & target_min, const T & target_max)
{
auto source_val = value;
source_val = std::min(source_val, std::max(source_min, source_max));
source_val = std::max(source_val, std::min(source_min, source_max));
auto coeff = -(target_max - target_min) / 2;
auto angle = (M_PI * (source_min - source_val)) / (source_min - source_max);
return coeff * std::cos(angle) + (target_max + target_min) / 2;
}

template<typename T>
T clamp(const T & value, const T & min, const T & max)
{
Expand Down Expand Up @@ -105,6 +131,22 @@ T smooth(T value, T target, T ratio)
return ((1.0 - ratio) * value) + (ratio * target);
}

template<typename T>
T curve(const T & value, const T & min, const T & max, const T & exponential)
{
if (min == max) {
return min;
}
auto val = clamp(value, min, max);
return min + ((max - min) * (std::pow(val - min, exponential) / std::pow(max - min, exponential)));
}

template<typename T>
T lerp(const T & start, const T & end, const T & rate)
{
return (start + ((end - start) * rate));
}

} // namespace keisan

#endif // KEISAN__NUMBER_IMPL_HPP_
156 changes: 156 additions & 0 deletions test/number_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,114 @@ TEST(NumberTest, MapFloatingPoint)
"5.2 + 7.0 = 12.2";
}

TEST(NumberTest, ExponentialMapIntegral)
{
EXPECT_EQ(ksn::exponentialmap(5, 2, 4, 0, 1), 1) <<
"clamp(5, 2, 4) = 4\n"
"map_coeff (0 <= 1) = 1\n"
"normalized_val = (4 - 2)/(4 - 2) = 1\n"
"1 * pow(|1 - 0 + 1|, 1) + 0 - 1 = 1\n";

EXPECT_EQ(ksn::exponentialmap(-5, -4, -2, 0, 1), 0) <<
"clamp(-5, -4, -2) = -4\n"
"map_coeff (0 <= 1) = 1\n"
"normalized_val = (-4 - (-4))/( -2 - (-4)) = 0\n"
"1 * pow(|1 - 0 + 1|, 0) + 0 - 1 = 0\n";
}

TEST(NumberTest, ExponentialMapFloatingPoint)
{
EXPECT_DOUBLE_EQ(ksn::exponentialmap(5.2, 1.8, 4.9, 0.4, 2.4), 2.4) <<
"clamp(5.2, 1.8, 4.9) = 4.9\n"
"map_coeff (0.4 <= 2.4) = 1\n"
"normalized_val = (4.9 - 1.8) / (4.9 - 1.8) = 1\n"
"1 * pow(|2.4 - 0.4 + 1|, 1) + 0.4 - 1 = 2.4\n";

EXPECT_DOUBLE_EQ(ksn::exponentialmap(-6.9, -4.2, -2.0, 0.0, 1.3), 0) <<
"clamp(-6.9, -4.2, -2.0) = -4.2\n"
"map_coeff (0.0 <= 1.3) = 1\n"
"normalized_val = (-4.2 - (-4.2)) / (-2.0 - (-4.2)) = 0\n"
"1 * pow(|1.3 - 0.0 + 1|, 0) + 0.0 - 1 = 0\n";

EXPECT_NEAR(ksn::exponentialmap(10.2, 3.1, 14.7, -2.2, 2.2), -0.393, 0.001) <<
"clamp(10.2, 3.1, 14.7) = 10.2\n"
"map_coeff (-2.2 <= 2.2) = 1\n"
"normalized_val = (10.2 - 3.1) / (14.7 - 3.1) = 0.6121\n"
"1 * pow(|2.2 - (-2.2) + 1|, 0.6121) + (-2.2) - 1 ~ -0.393\n";

EXPECT_NEAR(ksn::exponentialmap(10.2, 3.1, 14.7, 2.2, -2.2), 0.393, 0.001) <<
"clamp(10.2, 3.1, 14.7) = 10.2\n"
"map_coeff (2.2 <= -2.2) = -1\n"
"normalized_val = (10.2 - 3.1) / (14.7 - 3.1) = 0.6121\n"
"-1 * pow(|-2.2 - 2.2 + (-1)|, 0.6121) + 2.2 - (-1) ~ 0.393\n";

EXPECT_NEAR(ksn::exponentialmap(10.2, 14.7, 3.1, 2.2, -2.2), 1.276, 0.001) <<
"clamp(10.2, 14.7, 3.1) = 10.2\n"
"map_coeff (2.2 <= -2.2) = -1\n"
"normalized_val = (10.2 - 14.7) / (3.1 - 14.7) = 0.3879\n"
"-1 * pow(|-2.2 - 2.2 + (-1)|, 0.3879) + 2.2 - (-1) ~ 1.276\n";

EXPECT_NEAR(ksn::exponentialmap(10.2, 14.7, 3.1, -2.2, 2.2), -1.276, 0.001) <<
"clamp(10.2, 14.7, 3.1) = 10.2\n"
"map_coeff (-2.2 <= 2.2) = 1\n"
"normalized_val = (10.2 - 14.7) / (3.1 - 14.7) = 0.3879\n"
"1 * pow(|2.2 - (-2.2) + 1|, 0.3879) + (-2.2) - 1 ~ -1.276\n";
}

TEST(NumberTest, SinusoidalMapIntegral)
{
EXPECT_EQ(ksn::sinusoidalmap(10, 2, 4, 0, 2), 2) <<
"clamp(10, 2, 4) = 4\n"
"coeff = -(2 - 0) / 2 = -1\n"
"angle = (M_PI * (2 - 4)) / (2 - 4) = M_PI\n"
"-1 * cos(M_PI) + (2 + 0) / 2 = 2\n";

EXPECT_EQ(ksn::sinusoidalmap(-5, -4, -2, 0, 1), 0) <<
"clamp(-5, -4, -2) = -4\n"
"coeff = -(1 - 0) / 2 = -0.5\n"
"angle = (M_PI * (-4 - (-4))) / (-4 - (-2)) = 0\n"
"-0.5 * cos(0) + (1 + 0) / 2 = 0\n";
}

TEST(NumberTest, SinusoidalMapFloatingPoint)
{
EXPECT_DOUBLE_EQ(ksn::sinusoidalmap(5.2, 1.8, 4.9, 0.4, 2.4), 2.4) <<
"clamp(5.2, 1.8, 4.9) = 4.9\n"
"coeff = -(2.4 - 0.4) / 2 = -1\n"
"angle = (M_PI * (1.8 - 4.9)) / (1.8 - 4.9) = M_PI\n"
"-1 * cos(M_PI) + (2.4 + 0.4) / 2 = 2.4\n";

EXPECT_DOUBLE_EQ(ksn::sinusoidalmap(-6.9, -4.2, -2.0, 0.0, 1.3), 0) <<
"clamp(-6.9, -4.2, -2.0) = -4.2\n"
"coeff = -(1.3 - 0.0) / 2 = -0.65\n"
"angle = (M_PI * (-4.2 - (-4.2))) / (-4.2 - (-2.0)) = 0\n"
"-0.65 * cos(0) + (1.3 + 0.0) / 2 = 0.0\n";

EXPECT_NEAR(ksn::sinusoidalmap(10.2, 3.1, 14.7, -2.2, 2.2), 0.759, 0.001) <<
"clamp(10.2, 3.1, 14.7) = 10.2\n"
"coeff = -(2.2 - (-2.2)) / 2 = -2.2\n"
"angle = (M_PI * (3.1 - 10.2)) / (3.1 - 14.7) ~ 1.923\n"
"-2.2 * cos(1.923) + (2.2 + (-2.2)) / 2 ~ 0.759\n";

EXPECT_NEAR(ksn::sinusoidalmap(10.2, 3.1, 14.7, 2.2, -2.2), -0.759, 0.001) <<
"clamp(10.2, 3.1, 14.7) = 10.2\n"
"coeff = -(-2.2 - 2.2) / 2 = 2.2\n"
"angle = (M_PI * (3.1 - 10.2)) / (3.1 - 14.7) ~ 1.923\n"
"2.2 * cos(1.923) + (-2.2 + 2.2) / 2 ~ -0.759\n";

EXPECT_NEAR(ksn::sinusoidalmap(10.2, 14.7, 3.1, 2.2, -2.2), 0.759, 0.001) <<
"clamp(10.2, 14.7, 3.1) = 10.2\n"
"coeff = -(-2.2 - 2.2) / 2 = 2.2\n"
"angle = (M_PI * (14.7 - 10.2)) / (14.7 - 3.1) = 1.219\n"
"2.2 * cos(1.219) + (2.2 + (-2.2)) / 2 ~ 0.759\n";

EXPECT_NEAR(ksn::sinusoidalmap(10.2, 14.7, 3.1, -2.2, 2.2), -0.759, 0.001) <<
"clamp(10.2, 14.7, 3.1) = 10.2\n"
"coeff = -(2.2 - (-2.2)) / 2 = -2.2\n"
"angle = (M_PI * (14.7 - 10.2)) / (14.7 - 3.1) = 1.219\n"
"-2.2 * cos(1.219) + (-2.2 + 2.2) / 2 ~ -0.759\n";
}

TEST(NumberTest, ClampIntegral)
{
EXPECT_EQ(ksn::clamp(5, 0, 10), 5) << "0 <= 5 <= 10";
Expand Down Expand Up @@ -183,6 +291,54 @@ TEST(NumberTest, WrapFloatingPoint)
"0.2 + (1.1) = 1.3";
}

TEST(NumberTest, CurveIntegral)
{
EXPECT_EQ(ksn::curve(13, 10, 15, 2), 11) <<
"clamp(13, 10, 15) = 13\n"
"10 + (15 - 10) * ((13 - 10) / (15-10))^2 = 11";

EXPECT_EQ(ksn::curve(31, 10, 15, 2), 15) <<
"clamp(31, 10, 15) = 15\n"
"10 + (15 - 10) * ((15 - 10) / (15-10))^2 = 15";

EXPECT_EQ(ksn::curve(4, 10, 15, 2), 10) <<
"clamp(4, 10, 15) = 10\n"
"10 + (15 - 10) * ((10 - 10) / (15-10))^2 = 10";
}

TEST(NumberTest, CurveFloatingPoint)
{
EXPECT_EQ(ksn::curve(13.0, 10.0, 15.0, 2.0), 11.8) <<
"clamp(13, 10, 15) = 13\n"
"10 + (15 - 10) * ((13 - 10) / (15-10))^2 = 11.8";

EXPECT_EQ(ksn::curve(31.0, 10.0, 15.0, 2.0), 15.0) <<
"clamp(31, 10, 15) = 15\n"
"10 + (15 - 10) * ((15 - 10) / (15-10))^2 = 15";

EXPECT_EQ(ksn::curve(4.0, 10.0, 15.0, 2.0), 10.0) <<
"clamp(4, 10, 15) = 10\n"
"10 + (15 - 10) * ((10 - 10) / (15-10))^2 = 10";
}

TEST(NumberTest, LerpIntegral)
{
EXPECT_EQ(ksn::lerp(0, 10, 0), 0) <<
"0 + (10 - 0) * 0 = 0";

EXPECT_EQ(ksn::lerp(5, 15, 1), 15) <<
"5 + (15 - 5) * 1 = 15";
}

TEST(NumberTest, LerpFloatingPoint)
{
EXPECT_DOUBLE_EQ(ksn::lerp(0.0, 10.0, 0.5), 5.0) <<
"0 + (10 - 0) * 0.5 = 0";

EXPECT_DOUBLE_EQ(ksn::lerp(5.0, 15.0, 0.25), 7.5) <<
"5 + (15 - 5) * 0.25 = 15";
}

#define ASSERT_SMOOTH_NEAR(SOURCE, TARGET, RATIO, ...) \
{ \
double _source = SOURCE; \
Expand Down
Loading