Struct flag_algebra::SubClass

pub struct SubClass<F, A> {
    pub content: F,
    /* private fields */
}

A wrapper type for flags from a sub-class of flags.

This structure is meant to be used with the SubFlag trait. The second type parameter serves as an identifier for the subclass and should implement SubFlag<F>.

See the SubFlag page for an example.

Fields

content: F

Type of flag wrapped.

Implementations

impl<A, const K: u8> SubClass<CGraph<K>, A>

This should be properly implemented with a trait:

pub fn size(&self) -> usize

pub fn is_edge(&self, u: usize, v: usize) -> bool

pub fn edge(&self, u: usize, v: usize) -> u8

impl<A, const K: u8, const N: u8> SubClass<Colored<CGraph<K>, N>, A>

pub fn size(&self) -> usize

pub fn is_edge(&self, u: usize, v: usize) -> bool

pub fn edge(&self, u: usize, v: usize) -> u8

impl<A> SubClass<OrientedGraph, A>

pub fn size(&self) -> usize

Trait Implementations

impl<F, A> Canonize for SubClass<F, A>

where F: Flag,

fn size(&self) -> usize

Return the number of vertices.

fn invariant_neighborhood(&self, v: usize) -> Vec<Vec<usize>>

Return lists of vertices that are invariant isomorphism.

fn apply_morphism(&self, p: &[usize]) -> Self

Return the result of the action of a permuation p on the object.

fn invariant_coloring(&self) -> Option<Vec<u64>>

Optionally returns a value for each node that is invariant by isomorphism.

fn canonical(&self) -> Self

Computes a canonical form of a combinatorial object.

fn canonical_typed(&self, sigma: usize) -> Self

The “typed” objects refers to the case where only the action of permutations that are constant on 0..sigma are considered.

fn morphism_to_canonical(&self) -> Vec<usize>

Return a permutation p such that self.apply_morphism(&p) = self.canonical().

fn morphism_to_canonical_typed(&self, sigma: usize) -> Vec<usize>

Return a permutation phi such that g.apply_morphism(&phi) = canonical_typed(&g, sigma).

fn automorphisms(&self) -> AutomorphismIterator<Self>

Iterator on the automorphism group of g.

fn stabilizer(&self, sigma: usize) -> AutomorphismIterator<Self>

Iterator on the automorphisms of g that fix the sigma first vertices.

impl<F: Flag, A> Clone for SubClass<F, A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Flag, A> Debug for SubClass<F, A>

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

Formats the value using the given formatter.

impl<'de, F: Flag, A> Deserialize<'de> for SubClass<F, A>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Flag, A> Display for SubClass<F, A>

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

Formats the value using the given formatter.

impl<F, A> Draw for SubClass<F, A>

where F: Draw,

Inheritance

fn draw_with_parameters<C>(&self, color: C, type_size: usize) -> SVG

where C: FnMut(usize) -> usize,

fn draw(&self) -> SVG

fn draw_typed(&self, type_size: usize) -> SVG

fn to_svg_file(&self, filename: &str)

impl<F, A> Flag for SubClass<F, A>

where A: SubFlag<F>, F: Flag,

const NAME: &'static str = A::SUBCLASS_NAME

A unique name for this type of flags. For instance “Graph”. This nameis used for naming the associated data subdirectory.

const HEREDITARY: bool = A::HEREDITARY

Setting this parameter to false deactivate checks that induced subflags exists. Must be true in every classic case.

fn superflags(&self) -> Vec<Self>

Return the list of flags of size self.size() + 1 that contain self as an induced subflag.

fn induce(&self, p: &[usize]) -> Self

Returns the subflag induced by the vertices in the slice set.

fn size_zero_flags() -> Vec<Self>

Returns the set of all flags of size 0.

fn generate_next(previous: &[Self]) -> Vec<Self>

Return the list of flags of size self.size() + 1 that contain self as an induced subflag reduced modulo isomorphism.

fn generate(n: usize) -> Vec<Self>

Return the list of flags of size n reduced modulo isomorphism.

fn generate_typed_up(type_flag: &Self, g_vec: &[Self]) -> Vec<Self>

Return the list of flags of g_vec that can be rooted on the flag type_flag. Each different way to root this flag give a different flag in the result.

fn generate_typed(type_flag: &Self, size: usize) -> Vec<Self>

Return the list of flag of size size rooted on type_flag reduced modulo (typed) isomorphism.

fn select_type(&self, eta: &[usize]) -> Self

Reorder self so that the eta.len() first vertices are the values of eta in the corresponding order.

impl<F, A> From<F> for SubClass<F, A>

fn from(x: F) -> Self

Converts to this type from the input type.

impl<F: Flag, A> Ord for SubClass<F, A>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<F: Flag, A> PartialEq for SubClass<F, A>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: Flag, A> PartialOrd for SubClass<F, A>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<F: Flag, A> Serialize for SubClass<F, A>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: Flag, A> Eq for SubClass<F, A>