fmath

Math Library for my personal Rust Projects

About

This is not a general-purpose math library. It is specifically written for my purposes only.

Feel free to use it in your projects if it fits your needs, don't even worry about accreditation :)

Example

```rust

use fmath::{ self, vector::, matrix::, color::, hexadecimal:: };

// General let x = 5.0; let x_clamped = clamp( x, 0.0, 1.0 ); // 1.0

let numberlist:[f32;5] = [ 5.0, 7.0, 1.0, 80.0, -2.0 ]; let maxfromlist = max( &numberlist ); // 80.0 let minfromlist = min( &number_list ); // -2.0

let anothernumberlist:[u32;4] = [ 2, 3, 4, 1 ]; let maxfromanotherlist = max( &anothernumberlist ); // 4 let minfromanotherlist = min( &anothernumberlist ); // 1

let mut angle = 730.2; angle = degrees_overflow( angle ); // 10.2

let angleradians = degreesto_radians( angle ); // 0.1780236

let mut number:u8 = 254; number = u8addoverflowmaxclamp( number, 2 ); // 255 number = u8suboverflowmaxclamp( number, 256 ); // 0

// Vector math let v1 = Vector2::new( 1.0, 0.0 ); let v2 = Vector2::new( 0.0, 0.0 ); let v3 = v1 + v2; // ( 1.0, 1.0 )

let v1_mag = v1.magnitude(); // 1.0

// Matrix math let m1 = MATRIX4X4_ZERO.clone(); // creates empty Matrix array

let translate = Vector3::new( 0.0, 1.0, 0.0 ); let rotate = Vector3::new( 0.0, 0.0, 90.0 ); let scale = Vector3::new( 0.5, 0.5, 0.5 ); let m2 = Matrix4x4::newtrs([ // creates Translate-Rotate-Scale Matrix from Vector3's translate.asarray(), // accepts [f32;3] only rotate.asarray(), // accepts [f32;3] only scale.asarray(), // accepts [f32;3] only Angle::Degrees // sets angle type to degrees ]);

let point1 = Vector3::new( 1.0, 2.0, 3.0 ); let point1transformed:Vector3 = m2.mulvector3( point1 ); // apply transformation Matrix to Vector3

let point2 = Vector4::new( 1.0, 2.0, 3.0, 1.0 ); let point2transformed:Vector4 = m2.mulvector4( point2 ); // apply transformation Matrix to Vector4

// Colors let mut rgb = ColorRGB::new( 0.25, 0.25, 0.25 ); // creates RGB with given f32's let rgb8 = ColorRGB8::new( 160, 255, 0.0 ); // creates RGB8 with given u8's let rgba = ColorRGBA::from_hex( "994cd4" ); // creates RGBA from hex, sets alpha to 1.0

rgb = rgb8.into(); // convert RGB8 to RGB rgb[0] = 0.25; // address each component with index

let hsv = ColorHSV::new( 25.0, 0.5, 0.9 ); // creates HSV with given hue, saturation and value f32's

rgb = hsv.as_rgb(); // convert HSV to RGB

hsv = rgb.into(); // convert RGB8 to HSV

// All types (except Angle enum) implement fmt::Display println!("rgb: {}", rgb);

```

How to use

Include

in Cargo.toml file... rust [dependencies] fmath = "0.1.0"

Documentation

build documentation with cargo doc in the command line cargo doc

Library Contains...

Functions