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>
impl<'a> TraitsGenerator<'a>
Sourcepub fn new(
spec: &'a AlgebraSpec,
algebra: &'a Algebra,
table: ProductTable,
) -> Self
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.
Sourcepub fn with_options(
spec: &'a AlgebraSpec,
algebra: &'a Algebra,
table: ProductTable,
enable_groebner: bool,
) -> Self
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 specificationalgebra- The algebra for computationstable- The product table for term computationenable_groebner- Whether to enable Groebner basis simplification
Sourcepub fn generate_traits_file(&self) -> (TokenStream, String)
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
Source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
Source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> OverflowingAs for T
impl<T> OverflowingAs for T
Source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
Source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.
Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> SaturatingAs for T
impl<T> SaturatingAs for T
Source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
Source§fn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
Source§fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
Source§fn unwrapped_cast_from(src: Src) -> Dst
fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
Source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
Source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Source§impl<T> WrappingAs for T
impl<T> WrappingAs for T
Source§fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
Source§fn wrapping_cast_from(src: Src) -> Dst
fn wrapping_cast_from(src: Src) -> Dst
Casts the value.