Struct ciphercore_base::custom_ops::CustomOperation

pub struct CustomOperation { /* private fields */ }

A structure that stores a pointer to a custom operation.

A custom operation can be thought of as a polymorphic function, i.e., where the number of inputs and their types can vary.

Any struct can be a custom operation if it implements the CustomOperationBody trait. Then any such struct can be used to create a CustomOperation object that can be addded to a computation graph with Graph::custom_op.

Clone trait duplicates the pointer, not the underlying custom operation.

PartialEq trait compares the related custom operations, not just pointer.

Example

let c = create_context().unwrap();
let g = c.create_graph().unwrap();
let t = array_type(vec![3, 2], BIT);
let n1 = g.input(t).unwrap();
let n2 = g.custom_op(CustomOperation::new(Not {}), vec![n1]).unwrap();

Implementations

impl CustomOperation

pub fn new<T: 'static + CustomOperationBody>(op: T) -> CustomOperation

Creates a new custom operation that can be added to a computation graph via Graph::custom_op.

Arguments

op - struct that implements the CustomOperationBody trait

Returns

New custom operation

Example

let c = create_context().unwrap();
let g = c.create_graph().unwrap();
let t = array_type(vec![3, 2], BIT);
let n1 = g.input(t).unwrap();
let n2 = g.custom_op(CustomOperation::new(Not {}), vec![n1]).unwrap();

pub fn get_name(&self) -> String

Returns the name of the underlying custom operation by calling CustomOperationBody::get_name.

Returns

Name of this custom operation

Trait Implementations

impl Clone for CustomOperation

fn clone(&self) -> CustomOperation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomOperation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomOperation

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

Deserialize this value from the given Serde deserializer.

impl Hash for CustomOperation

fn hash<H: Hasher>(&self, state: &mut H)

Hashes the custom operation pointer.

Arguments

state - state of a hash function that is changed after hashing the custom operation

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<CustomOperation> for CustomOperation

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

Tests whether self and other custom operations are equal.

The underlying custom operation structs are compared via the Eq trait.

Arguments

other - another CustomOperation

Returns

true if the pointers in self and other point to equal custom operations, false otherwise

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

This method tests for !=.

impl Serialize for CustomOperation

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

Serialize this value into the given Serde serializer.

impl Eq for CustomOperation