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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
//!
//! No-STD fixed-point numeric implementation of trigonometric functions in Rust.
//!
//! It utilizes the [fixed](https://crates.io/crates/fixed) library to allow flexibility in fixed point sizes and precisions.
//!
//! The library [mixed-num](https://crates.io/crates/mixed-num) has these functions implemented as traits.
//!
//! The library [NDSP](https://crates.io/crates/ndsp) support fixed point numbers in vectors, with various implemented operations.
//!
//! ## Example
//!
//! ```
//! use fixed_trigonometry::*;
//! use fixed::{types::extra::U28, FixedI32};
//!
//! let arg = atan::atan( FixedI32::<U28>::from_num(0.6)/FixedI32::<U28>::from_num(0.4) );
//! assert_eq!{ arg.to_num::<f32>(), 0.9782037 };
//! ```
#![crate_name = "fixed_trigonometry"]
#![no_std]
// Use std for test.
#[cfg(all(not(feature = "std"), test))]
extern crate std;
use fixed;
use mixed_num::traits::*;
pub mod complex;
pub mod atan;
pub mod sqrt;
pub mod fft;
/// Rase fixed number to an integer-valued power.
/// `base^power`.
///
/// ## Arguments
///
/// * `base` - The base number.
/// * `power` - The power to raise 'base' to.
///
/// ## Example
///
/// ```
/// use fixed_trigonometry::*;
/// use fixed::{types::extra::U22, FixedI32};
///
/// let mut x = FixedI32::<U22>::from_num(-2);
/// let y = powi(x, 2);
/// assert_eq!{ y.to_num::<f32>(), 4.0 };
///
/// let y = powi(x, 0);
/// assert_eq!{ y.to_num::<f32>(), 1.0 };
/// ```
pub fn powi<T>( base:T, power:usize ) -> T
where T: MixedNum + MixedNumConversion<i32> + MixedOps
{
if power==0
{
return T::mixed_from_num(1i32);
}
let mut temp:T = base;
for _i in 0..power-1 {
temp = temp*base;
}
return temp;
}
/// Get the sign of the argument with a unit value.
/// Zero is of positive sign.
///
/// ## Arguments
///
/// * `x` - The function argument.
///
/// ## Example
///
/// ```
/// use fixed_trigonometry::*;
/// use fixed::{types::extra::U22, FixedI32};
///
/// let mut x = FixedI32::<U22>::from_num(-0.2);
/// let mut y = sign(x);
/// assert_eq!{ y.to_num::<f32>(), -1.0 };
///
/// x = FixedI32::<U22>::from_num(0.2);
/// y = sign(x);
/// assert_eq!{ y.to_num::<f32>(), 1.0 };
/// ```
pub fn sign<T>( x:T ) -> T
where T: fixed::traits::FixedSigned
{
if x<0
{
return T::from_num(-1);
}
else
{
return T::from_num(1);
}
}
/// Calculate sin(x) using a Taylor approximation of `sin(x)`.
///
/// Sin is calculated using the following polynomial:
///
/// `sin(x) = x -( x^3/6 )+( x^5/120 )-( x^7/5040 )+( x^9/362880 )`
///
/// ## Argument
///
/// * `x` - The value to apply the operation to.
///
/// `x` must be wrapped to the -π=<x<π range.
///
/// ## Example
///
/// ```
/// use fixed_trigonometry::*;
/// use fixed::{types::extra::U22, FixedI32};
///
/// let mut x = FixedI32::<U22>::from_num(0);
/// let mut y = sin(x);
/// assert_eq!{ y.to_num::<f32>(), 0.0 };
///
/// x = FixedI32::<U22>::from_num(3.1415/2.0);
/// y = sin(x);
/// assert_eq!{ y.to_num::<f32>(), 1.0000036 };
///
/// x = FixedI32::<U22>::from_num(3.1415);
/// y = sin(x);
/// assert_eq!{ y.to_num::<f32>(), 9.250641e-5 };
/// ```
///
/// ## Comparison and Error
///
/// The figure below shows the comparison between the polynomial sine, and the `std::f32::sin` implementation.
/// The Difference between the two is plotted as the error.
///
/// ![Alt version](https://github.com/ErikBuer/Fixed-Trigonometry/blob/main/figures/polynomial_sine_comparison.png?raw=true)
///
/// The error of the method is compared to the sine implementation in the cordic crate.
///
/// The comparison is done for U22 signed fixed point.
///
/// The figure below is missing numbers on the y axis, but it is plotted on a linear scale, showing the relative error between the two methods.
///
/// ![Alt version](https://github.com/ErikBuer/Fixed-Trigonometry/blob/main/figures/cordic_poly_sine_error_comparison.png?raw=true)
///
pub fn sin<T>( x: T ) -> T
where T: fixed::traits::FixedSigned + MixedNum + MixedNumConversion<i32> + MixedOps
{
let pi_half:T = <T>::from_num(fixed::consts::PI/2);
let mut x_: T = x;
// Ensure that the angle is within the accurate range of the tailor series.
if x_ < -pi_half
{
let delta:T = x+pi_half;
x_ = -pi_half-delta;
}
else if pi_half < x_
{
let delta:T = x-pi_half;
x_ = pi_half-delta;
}
// Calculate sine by using
let mut sinx = x_-( powi(x_,3)/<T>::from_num(6) );
sinx += powi(x_,5)/<T>::from_num(120);
sinx -= ( powi(x_,7)/<T>::from_num(315)) >> 4;
sinx += (((powi(x_,9)/<T>::from_num(81))/<T>::from_num(7))/<T>::from_num(5)) >> 7;
return sinx;
}
/// Calculate cosine using a Taylor approximation of `cos(x)`.
///
/// Cos is calculated by adding a phase shift to x and running it through the polynomial sine method.
///
/// ## Argument
///
/// * `x` - The value to apply the operation to.
///
/// `x` is wrapped to the -π=<x<π range in the function.
///
/// ## Example
///
/// ```
/// use fixed_trigonometry::*;
/// use fixed::{types::extra::U18, FixedI32};
///
/// let mut x = FixedI32::<U18>::from_num(0);
/// let mut y = cos(x);
/// assert_eq!{ y.to_num::<f32>(), 1.0000038 };
///
/// x = FixedI32::<U18>::from_num(3.1415/2.0);
/// y = cos(x);
/// assert_eq!{ y.to_num::<f32>(), 0.00004196167 };
/// ```
///
/// ## Comparison and Error
///
/// The figure below shows the comparison between the polynomial cosine, and the `std::f32::cos` implementation.
/// The Difference between the two is plotted as the error.
///
/// ![Alt version](https://github.com/ErikBuer/Fixed-Trigonometry/blob/main/figures/polynomial_cosine_comparison.png?raw=true)
///
/// The error of the method is compared to the sine implementation in the cordic crate.
///
/// The comparison is done for U22 signed fixed point.
///
/// The figure below is missing numbers on the y axis, but it is plotted on a linear scale, showing the relative error between the two methods.
///
/// ![Alt version](https://github.com/ErikBuer/Fixed-Trigonometry/blob/main/figures/cordic_poly_cos_error_comparison.png?raw=true)
///
pub fn cos<T>( x: T ) -> T
where T: fixed::traits::FixedSigned + MixedNum + MixedNumSigned + MixedOps + MixedPi
{
// shift to enable use of more accurate sinepolynomial method.
let pi_half = <T>::from_num(fixed::consts::PI/2);
let mut x_shifted = x+pi_half;
x_shifted = wrap_phase(x_shifted);
return sin(x_shifted);
}
/// Wrapps θ to the -π=<x<π range.
///
/// ## Arguments
///
/// * `phi` - The unwrapped phase in radians.
///
/// ## Example
///
/// ```
/// use fixed_trigonometry::*;
/// use fixed::{types::extra::U28, FixedI32};
///
/// let phi = FixedI32::<U28>::from_num(6);
/// let wrapped_phi = wrap_phase(phi);
/// assert_eq!{ wrapped_phi.to_num::<f32>(), -0.2831853 };
/// ```
pub fn wrap_phase<T>( phi: T ) -> T
where T: MixedNum + MixedNumSigned + MixedNumConversion<i32> + MixedOps + MixedPi
{
let mixed_pi = T::mixed_pi();
let tau = T::mixed_from_num(2)*mixed_pi;
let mut temp_scalar = phi;
while temp_scalar < -mixed_pi
{
temp_scalar = temp_scalar + tau;
}
while mixed_pi <= temp_scalar
{
temp_scalar = temp_scalar - tau;
}
return temp_scalar;
}