Struct smartnoise_runtime::proto::Resize

pub struct Resize {}

Resize Component

Resizes the data in question to be consistent with a provided sample size, n.

The library does not, in general, assume that the sample size of the data being analyzed is known. This introduces a number of problems around how to calculate statistics that are a function of the sample size.

To address this problem, the library asks the user to provide n, an estimate of the true sample size based on their own beliefs about the data or a previous differentially private count of the number of rows in the data. This component then either subsamples or appends to the data in order to make it consistent with the provided n.

Note that lower/upper/categorical arguments must be provided, or lower/upper/categorical properties must be known on data.

Note that if using categories constraint, data are treated as categorical regardless of atomic type.

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

Arguments

• data - Array - The data to be resized. Atomic type of data must match atomic type of categories. If categories not populated, data are treated as numeric and any necessary imputation is done according to a continuous distribution.
• number_rows - Array - An estimate of the number of rows in the data. This could be the guess of the user, or the result of a DP release. Cannot be set with minimum_rows.
• number_columns - Array - An estimate of the number of columns in the data. This must be the guess of the user, if not previously known (optional). A non-empty value must be positive. A non-empty value is incompatiable with an attempt to resize number of columns and results in an error.
• lower - Array - A lower bound on data elements for each column. This value must be less than upper.
• upper - Array - An upper bound on data elements for each column. This value must be greater than lower.
• categories - Jagged - The set of categories you want to be represented for each column of the data, if the data is categorical. Atomic type of data must match atomic type of categories.
• weights - Jagged - Optional. The weight of each category when imputing. Uniform weights are used if not specified.
• distribution - String - The distribution to be used when imputing records.
• shift - Array - The expectation of the Gaussian distribution used for imputation (used only if distribution = Gaussian).
• scale - Array - The standard deviation of the Gaussian distribution used for imputation (used only if distribution = Gaussian).
• sample_proportion - Array - The proportion of underlying data that may be used to construct the new data. May be > 1.
• minimum_rows - Array - Only add synthetic data if the actual row count is less than this number. No sampling is performed. Cannot be set with number_rows

Returns

• Value - Array - A resized version of data consistent with the provided n

Trait Implementations

impl Clone for Resize

pub fn clone(&self) -> Resize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Resize

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 Resize

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

Formats the value using the given formatter.

impl Default for Resize

pub fn default() -> Resize

Returns the “default value” for a type.

impl Evaluable for Resize

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 Resize

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 Resize

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

pub fn eq(&self, other: &Resize) -> 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 StructuralPartialEq for Resize