Skip to main content

Param

Enum Param 

Source
pub enum Param {
    Value(f64),
    Ref {
        index: usize,
        multiplier: f64,
        value: f64,
    },
}
Expand description

A numeric parameter for rotation and phase gates.

A Param is either a concrete floating-point value (Param::Value) or a symbolic reference to an entry in a parameter vector (Param::Ref). The Ref variant enables deferred parameter binding for variational algorithms where the same circuit is evaluated at multiple parameter points.

Variants§

§

Value(f64)

A concrete, pre-bound rotation angle (in radians).

§

Ref

A symbolic reference to a parameter vector entry.

The effective angle is value * multiplier. The value field stores the base value at binding time; multiplier can be adjusted (e.g., negated for inversion) without touching the underlying vector.

Fields

§index: usize

Zero-based index into the process parameter vector.

§multiplier: f64

Scaling factor applied to the parameter value.

§value: f64

The concrete value of the parameter at binding time.

Implementations§

Source§

impl Param

Source

pub fn inverse(&self) -> Self

Returns the mathematical inverse of the parameter (i.e., the negation).

For Value(v) this returns Value(-v); for Ref this negates the multiplier field.

Source

pub fn value(&self) -> f64

Returns the current floating-point value of the parameter.

For Param::Value this is a direct read. For Param::Ref the effective value is value * multiplier.

Source

pub fn set_parameter(&self, parameters: &[f64]) -> Self

Binds a symbolic Param::Ref to a concrete value from parameters.

If self is already a Param::Value it is returned unchanged. Otherwise the result is Value(base_value * multiplier * parameters[index]).

Source

pub fn add(&self, other: &Self) -> Option<Self>

Attempts to add two parameters together.

Returns Some(Value(a + b)) only when both operands are Param::Value. Any combination involving a Param::Ref returns None, because symbolic parameters cannot be merged algebraically at compile time.

Source

pub fn is_near_zero(&self, epsilon: f64) -> bool

Returns true if the parameter’s effective rotation angle is within epsilon of zero.

For Param::Ref only the multiplier is inspected, since the actual parameter value is not known at compile time.

Trait Implementations§

Source§

impl Clone for Param

Source§

fn clone(&self) -> Param

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Param

Source§

impl Debug for Param

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Param

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Param

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Param

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Param

Auto Trait Implementations§

§

impl Freeze for Param

§

impl RefUnwindSafe for Param

§

impl Send for Param

§

impl Sync for Param

§

impl Unpin for Param

§

impl UnsafeUnpin for Param

§

impl UnwindSafe for Param

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.