Struct smartnoise_runtime::proto::DpMean

pub struct DpMean {
    pub implementation: String,
    pub mechanism: String,
    pub privacy_usage: Vec<PrivacyUsage, Global>,
}

DPMean Component

Returns differentially private estimates of the means of each column of the data.

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 dp_mean on the arguments.

Arguments

• data - Array - Atomic type must be numeric.
• lower - Array - Estimated minimum possible value of the statistic. Only useful for the snapping mechanism.
• upper - Array - Estimated maximum possible value of the statistic. Only useful for the snapping mechanism.

Returns

• Value - Array - Differentially private estimate of the mean of each column of the data.

Fields

implementation: String

Privatizing algorithm to use. One of [resize, plug-in]

mechanism: String

Privatizing mechanism to use. One of [Laplace, Snapping, Gaussian, AnalyticGaussian].

privacy_usage: Vec<PrivacyUsage, Global>

Object describing the type and amount of privacy to be used for the mechanism release. Atomic data type value must be float. Example value: {‘epsilon’: 0.5}

Trait Implementations

impl Clone for DpMean

pub fn clone(&self) -> DpMean

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DpMean

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

Formats the value using the given formatter.

impl Default for DpMean

pub fn default() -> DpMean

Returns the “default value” for a type.

impl Expandable for DpMean

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>

Expand component

Arguments

• &self - this
• _privacy_definition - privacy definition from protocol buffer descriptor
• component - component from prototypes/components.proto
• _properties - NodeProperties
• component_id - identifier for component from prototypes/components.proto
• maximum_id - last ID value created for sequence, increment used to define current ID

impl Message for DpMean

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<DpMean> for DpMean

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

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

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

This method tests for !=.

impl Report for DpMean

pub fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value, RandomState>,
    properties: IndexMap<IndexKey, ValueProperties, RandomState>,
    release: &Value,
    variable_names: Option<&Vec<IndexKey, Global>>
) -> Result<Option<Vec<JSONRelease, Global>>, Error>

summarize results

Arguments

• &self - this
• node_id - identifier for node
• component - component from prototypes/components.proto
• public_arguments - HashMap of String, Value public arguments
• properties - NodeProperties
• release - JSONRelease containing DP release information

impl StructuralPartialEq for DpMean