fpn 0.1.2

Fixed point number
Documentation 
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

//! Fixed Point Numbers
//!
//! Fixed point number is designed to provide a memory presentation for real numbers.
//! Currently implemented only for a few cases for purpose of real usages, but will make it flexible enough later.
//!
//! FPN is the struct which contains a primitive for memory presentation with a specified length of
//! bits for fractions. Normal `F64` (`FPN<i64, U12>`) and `F32` (`FPN<i32, U8>`) should be fine
//! for usages. But be careful about the range overflow which doing `Add`, `Mul` and `Div`
//!
//! FPN also provides trigonometric functions including `sin`, `cos` and `tan`.
//!
//! `Vector2` and `Vector3` provides the graphic computation containers for 2D and 3D, while
//! `F64Vector2` (`Vector2<F64>`), `F64Vector3`, `F32Vector2` and `F32Vector3` for fixed numbers.
//!
//! `Dot` trait and `Cross` provides the dot product and cross product, while `Polar` trait
//! provides the function convert a Cartesian Coordinate to a Polar/Spherical Coordinates.
//! 
//! `Rotate2` trait and `Rotate3` trait provides the function to rotate `Vector2` around the origin 
//! point and rotate `Vector3` around the axises.
//!


// #![feature(const_fn)]
#[macro_use] pub mod base;
#[macro_use] pub mod cg;
pub mod common;

pub use base::{ FPN, To };
pub use common::{ FPN64, FPN32, F64, F32 };

pub use cg::{
    Vector2, Vector3, FVector2, FVector3, F64Vector2, F64Vector3,
    Dot, Polar, Cross, Rotate2, Rotate3,
};