Skip to main content

TraitsGenerator

Struct TraitsGenerator 

Source
pub struct TraitsGenerator<'a> { /* private fields */ }
Expand description

Generates trait implementations for algebra types.

The generator produces:

  • Arithmetic operators (Add, Sub, Neg, Mul)
  • Scalar multiplication
  • Geometric and outer product operators
  • Approx traits (AbsDiffEq, RelativeEq, UlpsEq)
  • Arbitrary implementations for proptest

§Example

use clifford_codegen::algebra::{Algebra, ProductTable};
use clifford_codegen::codegen::TraitsGenerator;
use clifford_codegen::spec::parse_spec;

let spec = parse_spec(r#"
[algebra]
name = "euclidean2"
complete = false

[signature]
positive = ["e1", "e2"]

[types.Vector]
grades = [1]
field_map = [
  { name = "x", blade = "e1" },
  { name = "y", blade = "e2" }
]

[types.Bivector]
grades = [2]
field_map = [
  { name = "xy", blade = "e12" }
]
"#).unwrap();

let algebra = Algebra::euclidean(2);
let table = ProductTable::new(&algebra);
let generator = TraitsGenerator::new(&spec, &algebra, table);

let (tokens, _tests) = generator.generate_traits_file();
let code = tokens.to_string();

assert!(code.contains("Add for Vector"));

Implementations§

Source§

impl<'a> TraitsGenerator<'a>

Source

pub fn new( spec: &'a AlgebraSpec, algebra: &'a Algebra, table: ProductTable, ) -> Self

Creates a new traits generator with default options.

Groebner simplification is enabled by default.

Source

pub fn with_options( spec: &'a AlgebraSpec, algebra: &'a Algebra, table: ProductTable, enable_groebner: bool, ) -> Self

Creates a new traits generator with explicit Groebner option.

§Arguments
  • spec - The algebra specification
  • algebra - The algebra for computations
  • table - The product table for term computation
  • enable_groebner - Whether to enable Groebner basis simplification
Source

pub fn generate_traits_file(&self) -> (TokenStream, String)

Generates the complete traits file.

Returns a tuple of (TokenStream, String) where:

  • The TokenStream contains the main code (operators, traits, arbitrary)
  • The String contains pre-formatted verification tests that should be appended after formatting the main code (rustfmt can’t format inside proptest! macros)

Auto Trait Implementations§

§

impl<'a> Freeze for TraitsGenerator<'a>

§

impl<'a> RefUnwindSafe for TraitsGenerator<'a>

§

impl<'a> Send for TraitsGenerator<'a>

§

impl<'a> Sync for TraitsGenerator<'a>

§

impl<'a> Unpin for TraitsGenerator<'a>

§

impl<'a> UnwindSafe for TraitsGenerator<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.