qsym2::symmetry::symmetry_transformation

Trait SpatialUnitaryTransformable

Source 
pub trait SpatialUnitaryTransformable: Clone {
    // Required method
    fn transform_spatial_mut(
        &mut self,
        rmat: &Array2<f64>,
        perm: Option<&Permutation<usize>>,
    ) -> Result<&mut Self, TransformationError>;

    // Provided method
    fn transform_spatial(
        &self,
        rmat: &Array2<f64>,
        perm: Option<&Permutation<usize>>,
    ) -> Result<Self, TransformationError> { ... }
}
Expand description

Trait for spatial unitary transformation. A spatial unitary transformation also permutes off-origin sites.

Required Methods§

Source

fn transform_spatial_mut( &mut self, rmat: &Array2<f64>, perm: Option<&Permutation<usize>>, ) -> Result<&mut Self, TransformationError>

Performs a spatial transformation in-place.

§Arguments
  • rmat - The three-dimensional representation matrix of the transformation in the basis of coordinate functions $(y, z, x)$.
  • perm - An optional permutation describing how any off-origin sites are permuted amongst each other under the transformation.

Provided Methods§

Source

fn transform_spatial( &self, rmat: &Array2<f64>, perm: Option<&Permutation<usize>>, ) -> Result<Self, TransformationError>

Performs a spatial transformation and returns the transformed result.

§Arguments
  • rmat - The three-dimensional representation matrix of the transformation in the basis of coordinate functions $(y, z, x)$.
§Returns

The transformed result.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§