Struct opendp::core::Transformation

pub struct Transformation<DI: Domain, DO: Domain, MI: Metric, MO: Metric> {
    pub input_domain: DI,
    pub output_domain: DO,
    pub function: Function<DI::Carrier, DO::Carrier>,
    pub input_metric: MI,
    pub output_metric: MO,
    pub stability_map: StabilityMap<MI, MO>,
}

Expand description

A data transformation with certain stability characteristics.

The trait bounds provided by the Rust type system guarantee that:

input_domain and output_domain are valid domains
input_metric and output_metric are valid metrics

It is, however, left to constructor functions to prove that:

metrics are compatible with domains
function is a mapping from the input domain to the output domain
stability_map is a mapping from the input metric to the output metric

Fields§

§input_domain: DI§output_domain: DO§function: Function<DI::Carrier, DO::Carrier>§input_metric: MI§output_metric: MO§stability_map: StabilityMap<MI, MO>

Implementations§

impl<DI: 'static + Domain, DO: 'static + Domain, MI: 'static + Metric, MO: 'static + Metric> Transformation<DI, DO, MI, MO>
where DI::Carrier: 'static, DO::Carrier: 'static, MI::Distance: 'static, MO::Distance: 'static, (DI, MI): MetricSpace, (DO, MO): MetricSpace,

pub fn into_any(self) -> AnyTransformation

impl<DI: Domain, DO: Domain, MI: Metric, MO: Metric> Transformation<DI, DO, MI, MO>
where (DI, MI): MetricSpace, (DO, MO): MetricSpace,

pub fn new( input_domain: DI, output_domain: DO, function: Function<DI::Carrier, DO::Carrier>, input_metric: MI, output_metric: MO, stability_map: StabilityMap<MI, MO>, ) -> Fallible<Self>

pub(crate) fn with_map<MI2: Metric, MO2: Metric>( &self, input_metric: MI2, output_metric: MO2, privacy_map: StabilityMap<MI2, MO2>, ) -> Fallible<Transformation<DI, DO, MI2, MO2>>
where (DI, MI2): MetricSpace, (DO, MO2): MetricSpace,

pub fn input_space(&self) -> (DI, MI)

pub fn output_space(&self) -> (DO, MO)

impl<DI: Domain, DO: Domain, MI: Metric, MO: Metric> Transformation<DI, DO, MI, MO>

pub fn invoke(&self, arg: &DI::Carrier) -> Fallible<DO::Carrier>

pub fn map(&self, d_in: &MI::Distance) -> Fallible<MO::Distance>

pub fn check(&self, d_in: &MI::Distance, d_out: &MO::Distance) -> Fallible<bool>
where MO::Distance: ProductOrd,

Trait Implementations§

impl<DI: Clone + Domain, DO: Clone + Domain, MI: Clone + Metric, MO: Clone + Metric> Clone for Transformation<DI, DO, MI, MO>
where DI::Carrier: Clone, DO::Carrier: Clone,

fn clone(&self) -> Transformation<DI, DO, MI, MO>

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<DI, DX, TO, MI, MX, MO> Shr<Measurement<DX, TO, MX, MO>> for Transformation<DI, DX, MI, MX>
where DI: 'static + Domain, DX: 'static + Domain, TO: 'static, MI: 'static + Metric, MX: 'static + Metric, MO: 'static + Measure, (DI, MI): MetricSpace, (DX, MX): MetricSpace,

type Output = Result<Measurement<DI, TO, MI, MO>, Error>

The resulting type after applying the >> operator.

fn shr(self, rhs: Measurement<DX, TO, MX, MO>) -> Self::Output

Performs the >> operation. Read more

impl<DI, DX, TO, MI, MX, MO> Shr<PartialMeasurement<DX, TO, MX, MO>> for Transformation<DI, DX, MI, MX>
where DI: 'static + Domain, DX: 'static + Domain, TO: 'static, MI: 'static + Metric, MX: 'static + Metric, MO: 'static + Measure, (DI, MI): MetricSpace, (DX, MX): MetricSpace,

type Output = Result<Measurement<DI, TO, MI, MO>, Error>

The resulting type after applying the >> operator.

fn shr(self, rhs: PartialMeasurement<DX, TO, MX, MO>) -> Self::Output

Performs the >> operation. Read more

impl<DI, DX, DO, MI, MX, MO> Shr<PartialTransformation<DX, DO, MX, MO>> for Transformation<DI, DX, MI, MX>
where DI: 'static + Domain, DX: 'static + Domain, DO: 'static + Domain, MI: 'static + Metric, MX: 'static + Metric, MO: 'static + Metric, (DI, MI): MetricSpace, (DX, MX): MetricSpace, (DO, MO): MetricSpace,

type Output = Result<Transformation<DI, DO, MI, MO>, Error>

The resulting type after applying the >> operator.

fn shr(self, rhs: PartialTransformation<DX, DO, MX, MO>) -> Self::Output

Performs the >> operation. Read more

impl<DI, DX, DO, MI, MO, MTI, MTO> Shr<Transformation<DX, DO, MTI, MTO>> for Measurement<DI, DX::Carrier, MI, MO>
where DI: 'static + Domain, DX: 'static + Domain, DO: 'static + Domain, MI: 'static + Metric, MO: 'static + Measure, MTI: 'static + Metric, MTO: 'static + Metric, (DI, MI): MetricSpace, (DX, MTI): MetricSpace, (DO, MTO): MetricSpace,

type Output = Result<Measurement<DI, <DO as Domain>::Carrier, MI, MO>, Error>

The resulting type after applying the >> operator.

fn shr(self, rhs: Transformation<DX, DO, MTI, MTO>) -> Self::Output

Performs the >> operation. Read more

impl<DI, DX, DO, MI, MO, MTI, MTO> Shr<Transformation<DX, DO, MTI, MTO>> for PartialMeasurement<DI, DX::Carrier, MI, MO>
where DI: 'static + Domain, DX: 'static + Domain, DO: 'static + Domain, MI: 'static + Metric, MO: 'static + Measure, MTI: 'static + Metric, MTO: 'static + Metric, (DI, MI): MetricSpace, (DX, MTI): MetricSpace, (DO, MTO): MetricSpace,

type Output = PartialMeasurement<DI, <DO as Domain>::Carrier, MI, MO>

The resulting type after applying the >> operator.

fn shr(self, rhs: Transformation<DX, DO, MTI, MTO>) -> Self::Output

Performs the >> operation. Read more

impl<DI, DX, DO, MI, MO, MTI, MTO> Shr<Transformation<DX, DO, MTI, MTO>> for Fallible<Measurement<DI, DX::Carrier, MI, MO>>
where DI: 'static + Domain, DX: 'static + Domain, DO: 'static + Domain, MI: 'static + Metric, MO: 'static + Measure, MTI: 'static + Metric, MTO: 'static + Metric, (DI, MI): MetricSpace, (DX, MTI): MetricSpace, (DO, MTO): MetricSpace,

type Output = Result<Measurement<DI, <DO as Domain>::Carrier, MI, MO>, Error>

The resulting type after applying the >> operator.

fn shr(self, rhs: Transformation<DX, DO, MTI, MTO>) -> Self::Output

Performs the >> operation. Read more

impl<DI, DX, DO, MI, MX, MO> Shr<Transformation<DX, DO, MX, MO>> for PartialTransformation<DI, DX, MI, MX>
where DI: 'static + Domain, DX: 'static + Domain, DO: 'static + Domain, MI: 'static + Metric, MX: 'static + Metric, MO: 'static + Metric, (DI, MI): MetricSpace, (DX, MX): MetricSpace, (DO, MO): MetricSpace,

type Output = PartialTransformation<DI, DO, MI, MO>

The resulting type after applying the >> operator.

fn shr(self, rhs: Transformation<DX, DO, MX, MO>) -> Self::Output

Performs the >> operation. Read more

impl<DI, DX, DO, MI, MX, MO> Shr<Transformation<DX, DO, MX, MO>> for Fallible<Transformation<DI, DX, MI, MX>>
where DI: 'static + Domain, DX: 'static + Domain, DO: 'static + Domain, MI: 'static + Metric, MX: 'static + Metric, MO: 'static + Metric, (DI, MI): MetricSpace, (DX, MX): MetricSpace, (DO, MO): MetricSpace,

type Output = Result<Transformation<DI, DO, MI, MO>, Error>

The resulting type after applying the >> operator.

fn shr(self, rhs: Transformation<DX, DO, MX, MO>) -> Self::Output

Performs the >> operation. Read more

impl<DI, DX, DO, MI, MX, MO> Shr<Transformation<DX, DO, MX, MO>> for Transformation<DI, DX, MI, MX>
where DI: 'static + Domain, DX: 'static + Domain, DO: 'static + Domain, MI: 'static + Metric, MX: 'static + Metric, MO: 'static + Metric, (DI, MI): MetricSpace, (DX, MX): MetricSpace, (DO, MO): MetricSpace,

type Output = Result<Transformation<DI, DO, MI, MO>, Error>

The resulting type after applying the >> operator.

fn shr(self, rhs: Transformation<DX, DO, MX, MO>) -> Self::Output

Performs the >> operation. Read more

Auto Trait Implementations§

impl<DI, DO, MI, MO> Freeze for Transformation<DI, DO, MI, MO>
where DI: Freeze, DO: Freeze, MI: Freeze, MO: Freeze,

impl<DI, DO, MI, MO> !RefUnwindSafe for Transformation<DI, DO, MI, MO>

impl<DI, DO, MI, MO> Send for Transformation<DI, DO, MI, MO>

impl<DI, DO, MI, MO> Sync for Transformation<DI, DO, MI, MO>

impl<DI, DO, MI, MO> Unpin for Transformation<DI, DO, MI, MO>
where DI: Unpin, DO: Unpin, MI: Unpin, MO: Unpin,

impl<DI, DO, MI, MO> !UnwindSafe for Transformation<DI, DO, MI, MO>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V