Enum CodeType 

pub enum CodeType {
    StandardPlanarCode,
    RotatedPlanarCode,
    StandardXZZXCode,
    RotatedXZZXCode,
    StandardTailoredCode,
    RotatedTailoredCode,
    RotatedTailoredCodeBellInit,
    PeriodicRotatedTailoredCode,
    Customized,
}

commonly used code type that has built-in functions to automatically build up the simulator. other type of code type is also feasible, but one needs to implement the generation of code patch.

Variants

StandardPlanarCode

noisy measurement rounds (excluding the final perfect measurement cap), vertical code distance, horizontal code distance

RotatedPlanarCode

noisy measurement rounds (excluding the final perfect measurement cap), +i+j axis code distance, +i-j axis code distance

StandardXZZXCode

noisy measurement rounds (excluding the final perfect measurement cap), vertical code distance, horizontal code distance

RotatedXZZXCode

noisy measurement rounds (excluding the final perfect measurement cap), +i+j axis code distance, +i-j axis code distance

StandardTailoredCode

noisy measurement rounds (excluding the final perfect measurement cap), vertical code distance, horizontal code distance

RotatedTailoredCode

noisy measurement rounds (excluding the final perfect measurement cap), +i+j axis code distance, +i-j axis code distance

RotatedTailoredCodeBellInit

same as RotatedTailoredCode but with first measurement cycle modified for bell state initialization

PeriodicRotatedTailoredCode

periodic boundary condition of rotated tailored surface code, code distances must be even number

Customized

unknown code type, user must provide necessary information and build circuit-level implementation

Implementations

impl CodeType

pub fn get_left( &self, i: usize, j: usize, code_size: &CodeSize, ) -> (usize, usize)

get position on the left of (i, j), note that this position may be invalid for open-boundary code if it doesn’t exist

pub fn get_up(&self, i: usize, j: usize, code_size: &CodeSize) -> (usize, usize)

get position up the position (i, j), note that this position may be invalid for open-boundary code if it doesn’t exist

pub fn get_right( &self, i: usize, j: usize, code_size: &CodeSize, ) -> (usize, usize)

get position on the right of (i, j), note that this position may be invalid for open-boundary code if it doesn’t exist

pub fn get_down( &self, i: usize, j: usize, code_size: &CodeSize, ) -> (usize, usize)

get position down the position (i, j), note that this position may be invalid for open-boundary code if it doesn’t exist

pub fn get_left_up( &self, i: usize, j: usize, code_size: &CodeSize, ) -> (usize, usize)

convenient call to get diagonal neighbor on the left up

pub fn get_left_down( &self, i: usize, j: usize, code_size: &CodeSize, ) -> (usize, usize)

convenient call to get diagonal neighbor on the left down

pub fn get_right_up( &self, i: usize, j: usize, code_size: &CodeSize, ) -> (usize, usize)

convenient call to get diagonal neighbor on the right up

pub fn get_right_down( &self, i: usize, j: usize, code_size: &CodeSize, ) -> (usize, usize)

convenient call to get diagonal neighbor on the left down

Trait Implementations

impl Clone for CodeType

fn clone(&self) -> CodeType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CodeType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for CodeType

fn cmp(&self, other: &CodeType) -> 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,

Restrict a value to a certain interval.

impl PartialEq for CodeType

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for CodeType

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for CodeType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ValueEnum for CodeType

fn value_variants<'a>() -> &'a [Self]

All possible argument values, in display order.

fn to_possible_value<'a>(&self) -> Option<PossibleValue>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.

impl Copy for CodeType

impl Eq for CodeType

impl StructuralPartialEq for CodeType