Struct smartnoise_validator::proto::Clamp

pub struct Clamp {}

Clamp Component

Clamps data to the provided bounds.

If data are numeric, clamping maps elements outside of an interval [lower, upper] to the closer endpoint. If data are categorical, clamping maps elements outside of the categories argument to the associated null. Using clamp sets the categories property for the analysis with value categories plus null_value in the last position.

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

Arguments

• data - Array - Data to be clamped.
• lower - Array - Desired lower bound for each column of the data. Used only if categories is None.
• upper - Array - Desired upper bound for each column of the data. Used only if categories is None.
• categories - Jagged - The set of categories you want to be represented for each column of the data, or None.
• 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.

Returns

• Value - Array - Clamped data.

Trait Implementations

impl Clone for Clamp

fn clone(&self) -> Clamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Clamp

fn propagate_property(
    &self,
    _privacy_definition: &Option<PrivacyDefinition>,
    public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    _node_id: u32
) -> Result<Warnable<ValueProperties>>

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

impl Debug for Clamp

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

Formats the value using the given formatter.

impl Default for Clamp

fn default() -> Clamp

Returns the “default value” for a type.

impl Expandable for Clamp

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 Clamp

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

fn eq(&self, other: &Clamp) -> 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 Clamp