Struct ciphercore_base::ops::clip::Clip2K

pub struct Clip2K {
    pub k: u64,
}

A structure that defines the custom operation Clip2K that computes elementwise the following clipping function:

• 0 if input <= 0,
• input if 0 < input < 2^k,
• 2^k if >= 2^k.

This function is an approximation of the sigmoid function.

An array of length-n bitstrings is accepted as input. These bitstrings are interpreted as signed integers.

To use this and other custom operations in computation graphs, see Graph::custom_op.

Custom operation arguments

• Node containing a binary array

Custom operation returns

New Clip2K node

Example

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

Fields

k: u64

2^k is the upper threshold of clipping

Trait Implementations

impl CustomOperationBody for Clip2K

fn instantiate(
    &self,
    context: Context,
    arguments_types: Vec<Type>
) -> Result<Graph>

Defines the logic of a custom operation.

fn get_name(&self) -> String

Specifies and returns the name of this custom operation.

impl Debug for Clip2K

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Clip2K

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

Deserialize this value from the given Serde deserializer.

impl Hash for Clip2K

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Clip2K> for Clip2K

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

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

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

This method tests for !=.

impl Serialize for Clip2K

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 Clip2K

impl StructuralEq for Clip2K

impl StructuralPartialEq for Clip2K