Struct smartnoise_validator::proto::DpRawMoment

[+] Show declaration

pub struct DpRawMoment {
    pub order: u32,
    pub mechanism: String,
    pub privacy_usage: Vec<PrivacyUsage>,
}

[−] Expand description

DPRawMoment Component

Returns differentially private sample estimate of a raw moment for 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_raw_moment on the arguments.

Arguments

• data - Array - Data for which you would like the kth raw moments. Atomic data type must be float.
• 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 sample estimate of kth raw moment for each column of the data.

Fields

order: u32

[−] Expand description

Integer statistical moment indicator.

mechanism: String

[−] Expand description

Privatizing mechanism to use. Value must be one of [Automatic, Laplace, Snapping, Gaussian, AnalyticGaussian].

privacy_usage: Vec<PrivacyUsage>

[−] Expand description

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 DpRawMoment[+]

[+] Show hidden undocumented items

fn clone(&self) -> DpRawMoment[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DpRawMoment[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for DpRawMoment[+]

[+] Show hidden undocumented items

fn default() -> DpRawMoment[−]

Returns the “default value” for a type.

impl Expandable for DpRawMoment[+]

[+] Show hidden undocumented items

fn expand_component(
    &self,
    privacy_definition: &Option<PrivacyDefinition>,
    component: &Component,
    _public_arguments: &IndexMap<IndexKey, &Value>,
    _properties: &NodeProperties,
    component_id: u32,
    maximum_id: u32
) -> Result<ComponentExpansion>[−]

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

impl Message for DpRawMoment[+]

[+] Show hidden undocumented items

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

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

fn encoded_len(&self) -> usize[−]

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

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<DpRawMoment> for DpRawMoment[+]

[+] Show hidden undocumented items

fn eq(&self, other: &DpRawMoment) -> bool[−]

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

fn ne(&self, other: &DpRawMoment) -> bool[−]

This method tests for !=.

impl Report for DpRawMoment[+]

[+] Show hidden undocumented items

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>[−]

Summarize the relevant metadata around a computation in a readable, JSON-serializable format.

impl StructuralPartialEq for DpRawMoment