DependentType

Struct DependentType 

Source
pub struct DependentType {
    pub base_type: String,
    pub type_params: Vec<String>,
    pub dim_params: Vec<DimExpr>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub constraints: Vec<DimConstraint>,
}
Expand description

A dependent type with dimension parameters.

Fields§

§base_type: String

Base type name

§type_params: Vec<String>

Type parameters (other types)

§dim_params: Vec<DimExpr>

Dimension parameters

§name: Option<String>

Optional name for the dependent type

§description: Option<String>

Description

§constraints: Vec<DimConstraint>

Constraints between dimensions

Implementations§

Source§

impl DependentType

Source

pub fn new(base_type: impl Into<String>) -> Self

Create a new dependent type with a base type.

Source

pub fn scalar(element_type: impl Into<String>) -> Self

Create a scalar type.

Source

pub fn vector(element_type: impl Into<String>, length: DimExpr) -> Self

Create a vector type with a dimension.

Source

pub fn matrix( element_type: impl Into<String>, rows: DimExpr, cols: DimExpr, ) -> Self

Create a matrix type with dimensions.

Source

pub fn tensor(element_type: impl Into<String>, dims: Vec<DimExpr>) -> Self

Create a tensor type with arbitrary dimensions.

Source

pub fn with_name(self, name: impl Into<String>) -> Self

Set the name of this type.

Source

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description.

Source

pub fn with_type_param(self, param: impl Into<String>) -> Self

Add a type parameter.

Source

pub fn with_dim_param(self, dim: DimExpr) -> Self

Add a dimension parameter.

Source

pub fn with_constraint(self, constraint: DimConstraint) -> Self

Add a dimension constraint.

Source

pub fn type_name(&self) -> String

Get the effective name.

Source

pub fn eval_shape(&self, ctx: &DependentTypeContext) -> Option<Vec<usize>>

Evaluate the shape of this type in a context.

Source

pub fn rank(&self) -> usize

Get the rank (number of dimensions).

Source

pub fn free_variables(&self) -> Vec<String>

Get all free dimension variables.

Source

pub fn check_constraints( &self, ctx: &DependentTypeContext, ) -> Result<(), String>

Check if constraints are satisfied in a context.

Source

pub fn is_compatible_with( &self, other: &DependentType, ctx: &DependentTypeContext, ) -> bool

Check if this type is compatible with another for assignment.

Trait Implementations§

Source§

impl Clone for DependentType

Source§

fn clone(&self) -> DependentType

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DependentType

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.