Struct smartnoise_runtime::proto::SnappingMechanism

pub struct SnappingMechanism {
    pub privacy_usage: Vec<PrivacyUsage, Global>,
}

SnappingMechanism Component

Privatizes a result by returning it perturbed via the Snapping mechanism. This mechanism is generally intended for non-integer numerical data. Note that snapping may not operate on integers when floating-point protections are enabled. For this situation, use the geometric mechanism instead.

This struct represents an abstract computation. Arguments are provided via the graph. Additional options are set via the fields on this struct. The return is the result of the snapping_mechanism on the arguments.

Arguments

• data - Array - Result to be released privately via the Snapping mechanism. Array members must be of type float or of type integer.
• lower - Array - Estimated minimum possible value of the data. Only useful for the snapping mechanism. This argument is required.
• upper - Array - Estimated maximum possible value of the statistic. Only useful for the snapping mechanism. This argument is required.
• binding_probability - Array - Upper bound on probability that final clamp binds. Must be within [0, 1).
• sensitivity - Array - Override the sensitivity computed by the library. Rejected unless protect_sensitivity is disabled.

Returns

• Value - Array - Original data perturbed via the Snapping mechanism.

Fields

privacy_usage: Vec<PrivacyUsage, Global>

Object describing the type and amount of privacy to be used for the mechanism release.

Trait Implementations

impl Accuracy for SnappingMechanism

pub fn accuracy_to_privacy_usage(
    &self,
    accuracies: &Accuracies,
    public_arguments: IndexMap<IndexKey, &Value, RandomState>
) -> Result<Option<Vec<PrivacyUsage, Global>>, Error>

pub fn privacy_usage_to_accuracy(
    &self,
    public_arguments: IndexMap<IndexKey, &Value, RandomState>,
    alpha: f64
) -> Result<Option<Vec<Accuracy, Global>>, Error>

impl Clone for SnappingMechanism

pub fn clone(&self) -> SnappingMechanism

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for SnappingMechanism

pub fn propagate_property(
    &self,
    privacy_definition: &Option<PrivacyDefinition>,
    _public_arguments: IndexMap<IndexKey, &Value, RandomState>,
    properties: IndexMap<IndexKey, ValueProperties, RandomState>,
    _node_id: u32
) -> Result<Warnable<ValueProperties>, Error>

Given properties known about private arguments, and public arguments, derive properties about the resulting data.

impl Debug for SnappingMechanism

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

Formats the value using the given formatter.

impl Default for SnappingMechanism

pub fn default() -> SnappingMechanism

Returns the “default value” for a type.

impl Evaluable for SnappingMechanism

fn evaluate(
    &self,
    privacy_definition: &Option<PrivacyDefinition>,
    arguments: NodeArguments
) -> Result<ReleaseNode>

The concrete implementation of the abstract computation that the struct represents.

impl Expandable for SnappingMechanism

pub fn expand_component(
    &self,
    privacy_definition: &Option<PrivacyDefinition>,
    component: &Component,
    _public_arguments: &IndexMap<IndexKey, &Value, RandomState>,
    properties: &IndexMap<IndexKey, ValueProperties, RandomState>,
    component_id: u32,
    maximum_id: u32
) -> Result<ComponentExpansion, Error>

Concrete implementation for an Expandable component that returns a patch that may be applied to a computation graph.

impl Mechanism for SnappingMechanism

pub fn get_privacy_usage(
    &self,
    privacy_definition: &PrivacyDefinition,
    release_usage: Option<&Vec<PrivacyUsage, Global>>,
    properties: &IndexMap<IndexKey, ValueProperties, RandomState>
) -> Result<Option<Vec<PrivacyUsage, Global>>, Error>

Extraction of privacy usage by the component.

impl Message for SnappingMechanism

pub fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

pub fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

pub fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<SnappingMechanism> for SnappingMechanism

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

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

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

This method tests for !=.

impl StructuralPartialEq for SnappingMechanism