fidget-core 0.4.3

Core infrastructure for Fidget
Documentation
//! Core infrastructure for evaluating complex closed-form implicit surfaces.
//!
//! ```
//! use fidget_core::{
//!     context::Context,
//!     shape::EzShape,
//!     vm::VmShape
//! };
//! let mut ctx = Context::new();
//! let x = ctx.x();
//! let y = ctx.y();
//! let x_squared = ctx.mul(x, x)?;
//! let y_squared = ctx.mul(y, y)?;
//! let radius = ctx.add(x_squared, y_squared)?;
//! let circle = ctx.sub(radius, 1.0)?;
//!
//! let shape = VmShape::new(&ctx, circle)?;
//! let mut eval = VmShape::new_point_eval();
//! let tape = shape.ez_point_tape();
//!
//! let (v, _trace) = eval.eval(&tape, 0.0, 0.0, 0.0)?;
//! assert_eq!(v, -1.0);
//!
//! let (v, _trace) = eval.eval(&tape, 1.0, 0.0, 0.0)?;
//! assert_eq!(v, 0.0);
//!
//! const N: usize = 15;
//! for i in 0..N {
//!     for j in 0..N {
//!         let x = (i as f32 + 0.5) / (N as f32 / 2.0) - 1.0;
//!         let y = (j as f32 + 0.5) / (N as f32 / 2.0) - 1.0;
//!         let (v, _trace) = eval.eval(&tape, x, y, 0.0)?;
//!         print!("{}", if v < 0.0 { "##" } else { "  " });
//!     }
//!     println!();
//! }
//!
//! // This will print
//! //           ##########
//! //       ##################
//! //     ######################
//! //   ##########################
//! //   ##########################
//! // ##############################
//! // ##############################
//! // ##############################
//! // ##############################
//! // ##############################
//! //   ##########################
//! //   ##########################
//! //     ######################
//! //       ##################
//! //           ##########
//! # Ok::<(), fidget_core::Error>(())
//! ```
#![warn(missing_docs)]

pub mod context;
pub use context::Context;

pub mod compiler;
pub mod eval;
pub mod render;
pub mod shape;
pub mod types;
pub mod var;
pub mod vm;

mod error;
pub use error::Error;

#[cfg(test)]
mod test {
    use crate::Error;
    use crate::context::*;
    use crate::var::Var;

    #[test]
    fn it_works() {
        let mut ctx = Context::new();
        let x1 = ctx.x();
        let x2 = ctx.x();
        assert_eq!(x1, x2);

        let a = ctx.constant(1.0);
        let b = ctx.constant(1.0);
        assert_eq!(a, b);
        assert_eq!(ctx.get_const(a).unwrap(), 1.0);
        assert!(matches!(ctx.get_const(x1), Err(Error::NotAConst)));

        let c = ctx.add(a, b).unwrap();
        assert_eq!(ctx.get_const(c).unwrap(), 2.0);

        let c = ctx.neg(c).unwrap();
        assert_eq!(ctx.get_const(c).unwrap(), -2.0);
    }

    #[test]
    fn test_constant_folding() {
        let mut ctx = Context::new();
        let a = ctx.constant(1.0);
        assert_eq!(ctx.len(), 1);
        let b = ctx.constant(-1.0);
        assert_eq!(ctx.len(), 2);
        let _ = ctx.add(a, b);
        assert_eq!(ctx.len(), 3);
        let _ = ctx.add(a, b);
        assert_eq!(ctx.len(), 3);
        let _ = ctx.mul(a, b);
        assert_eq!(ctx.len(), 3);
    }

    #[test]
    fn test_eval() {
        let mut ctx = Context::new();
        let x = ctx.x();
        let y = ctx.y();
        let v = ctx.add(x, y).unwrap();

        assert_eq!(
            ctx.eval(v, &[(Var::X, 1.0), (Var::Y, 2.0)].into_iter().collect())
                .unwrap(),
            3.0
        );
        assert_eq!(ctx.eval_xyz(v, 2.0, 3.0, 0.0).unwrap(), 5.0);
    }
}