Struct smartnoise_runtime::proto::Histogram

pub struct Histogram {}

Histogram Component

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

Arguments

• data - Array
• edges - Jagged - Set of edges to bin continuous-valued data. Used only if data are of continuous nature. Must have a value if categories not specified.
• categories - Jagged - Set of categories in data. Used only if data are of categorical nature. Must have a value if edges not specified.
• 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.
• inclusive_left - - 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

Trait Implementations

impl Clone for Histogram

pub fn clone(&self) -> Histogram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Histogram

pub fn propagate_property(
    &self,
    _privacy_definition: &Option<PrivacyDefinition>,
    _public_arguments: IndexMap<IndexKey, &Value, RandomState>,
    properties: IndexMap<IndexKey, ValueProperties, RandomState>,
    node_id: u32
) -> Result<Warnable<ValueProperties>, Error>

Given properties known about private arguments, and public arguments, derive properties about the resulting data.

impl Debug for Histogram

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

Formats the value using the given formatter.

impl Default for Histogram

pub fn default() -> Histogram

Returns the “default value” for a type.

impl Evaluable for Histogram

fn evaluate(
    &self,
    _privacy_definition: &Option<PrivacyDefinition>,
    arguments: NodeArguments
) -> Result<ReleaseNode>

The concrete implementation of the abstract computation that the struct represents.

impl Expandable for Histogram

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>

If min and max are not supplied, but are known statically, then add them automatically Add nodes for clamp or digitize if categories or edges are passed

impl Message for Histogram

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

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Sensitivity for Histogram

pub fn compute_sensitivity(
    &self,
    privacy_definition: &PrivacyDefinition,
    properties: &IndexMap<IndexKey, ValueProperties, RandomState>,
    sensitivity_type: &SensitivitySpace
) -> Result<Value, Error>

Histogram sensitivities are backed by the the proofs here.

impl StructuralPartialEq for Histogram