Struct smartnoise_runtime::proto::DpCovariance

pub struct DpCovariance {
    pub mechanism: String,
    pub privacy_usage: Vec<PrivacyUsage, Global>,
    pub finite_sample_correction: bool,
}

DPCovariance Component

Calculate differentially private covariance.

If data argument is provided as a 2D array, calculate covariance matrix. Otherwise, left and right 1D arrays are used to calculate a cross-covariance matrix between elements of the two arrays.

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

Arguments

• left - Array - Left data array used to calculate cross-covariance matrix. Used only if data not provided.
• right - Array - Right data array used to calculate cross-covariance matrix. Used only if data not provided.
• data - Array - 2D data array used to construct covariance matrix.
• 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 - Flattened covariance or cross-covariance matrix.

Fields

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}

finite_sample_correction: bool

Whether or not to use the finite sample correction (Bessel’s correction).

Trait Implementations

impl Clone for DpCovariance

pub fn clone(&self) -> DpCovariance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DpCovariance

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

Formats the value using the given formatter.

impl Default for DpCovariance

pub fn default() -> DpCovariance

Returns the “default value” for a type.

impl Expandable for DpCovariance

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 Message for DpCovariance

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

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

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

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

This method tests for !=.

impl Report for DpCovariance

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 the relevant metadata around a computation in a readable, JSON-serializable format.

impl StructuralPartialEq for DpCovariance