Struct smartnoise_runtime::proto::DpCount

pub struct DpCount {
    pub distinct: bool,
    pub mechanism: String,
    pub privacy_usage: Vec<PrivacyUsage, Global>,
}

DPCount Component

Returns a differentially private row count.

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

Arguments

• data - Array
• lower - Array - Estimated minimum possible value of the statistic. Useful to help bound elapsed time when sampling for the geometric mechanism. Required for the snapping mechanism.
• upper - Array - Estimated maximum possible value of the statistic. Useful to help bound elapsed time when sampling for the geometric mechanism. Required for the snapping mechanism.

Returns

• Value - Array - Differentially private row count.

Fields

distinct: bool

Set to true for the number of unique members in the data.

mechanism: String

Privatizing mechanism to use. One of [SimpleGeometric, Laplace, Snapping, Gaussian, AnalyticGaussian]. Only SimpleGeometric is accepted if floating-point protections are enabled.

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 DpCount

pub fn clone(&self) -> DpCount

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DpCount

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

Formats the value using the given formatter.

impl Default for DpCount

pub fn default() -> DpCount

Returns the “default value” for a type.

impl Expandable for DpCount

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 DpCount

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

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

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

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

This method tests for !=.

impl Report for DpCount

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 DpCount