Struct smartnoise_runtime::proto::DpHistogram

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

DPHistogram Component

Returns a differentially private histogram over user-defined categories. The final cell contains the counts for null values (outside the set of categories).

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

Arguments

• data - Array - Atomic type must be numeric.
• edges - Jagged - Set of edges to bin continuous-valued data. Used only if data are of continuous nature.
• categories - Jagged - Set of categories in data. Used only if data are of categorical nature.
• null_value - Array - The value to which elements not included in categories will be mapped for each column of the data. Used only if categories is not None. The null value is the final category- counts for the null category are at the end of the vector of counts.
• lower - Array - Estimated minimum possible value of bin counts. Useful to help bound elapsed time when sampling for the geometric mechanism. Required for the snapping mechanism.
• upper - Array - Estimated maximum possible value of bin counts. Useful to help bound elapsed time when sampling for the geometric mechanism. Required for the snapping mechanism.
• inclusive_left - Array - Whether or not the left edge of the bin is inclusive. If true bins are of the form [lower, upper). Otherwise, bins are of the form (lower, upper]. Used only if data are of continuous nature.

Returns

• Value - Array - Differentially private histogram.

Fields

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.

Trait Implementations

impl Clone for DpHistogram

pub fn clone(&self) -> DpHistogram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DpHistogram

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

Formats the value using the given formatter.

impl Default for DpHistogram

pub fn default() -> DpHistogram

Returns the “default value” for a type.

impl Expandable for DpHistogram

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 DpHistogram

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

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

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

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

This method tests for !=.

impl Report for DpHistogram

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 DpHistogram