Struct opendp::domains::OptionDomain

pub struct OptionDomain<D: Domain> {
    pub element_domain: D,
}

A domain that represents nullity via the Option type.

Proof Definition

OptionDomain(element_domain, D) is the domain of all values of element_domain (of type D, a domain) wrapped in Some, as well as None.

Notes

This is used to represent nullity for data types like integers or strings, for which all values they take on are non-null.

Example

use opendp::domains::{OptionDomain, AtomDomain};
let null_domain = OptionDomain::new(AtomDomain::default());

use opendp::core::Domain;
assert!(null_domain.member(&Some(1))?);
assert!(null_domain.member(&None)?);

Fields

element_domain: D

Implementations

impl<D: Domain> OptionDomain<D>

pub fn new(member_domain: D) -> Self

Trait Implementations

impl<D: Clone + Domain> Clone for OptionDomain<D>

fn clone(&self) -> OptionDomain<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Domain> Debug for OptionDomain<D>

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

Formats the value using the given formatter.

impl<D: Domain + Default> Default for OptionDomain<D>

fn default() -> Self

Returns the “default value” for a type.

impl<D: Domain> Domain for OptionDomain<D>

type Carrier = Option<<D as Domain>::Carrier>

The underlying type that the Domain specializes. This is the type of a member of a domain, where a domain is any data type that implements this trait.

fn member(&self, value: &Self::Carrier) -> Fallible<bool>

Predicate to test an element for membership in the domain. Not all possible values of ::Carrier are a member of the domain.

impl<T: CheckAtom + Clone> DropNullDomain for OptionDomain<AtomDomain<T>>

how to standardize into an option, when null represented as Option<T>

type Imputed = T

This is the type of Self::Carrier after dropping null.

fn option(value: &Self::Carrier) -> Option<T>

Standardizes D::Carrier into an Option<D::Imputed>, where D::Imputed is never null.

impl<T: CheckAtom> ImputeConstantDomain for OptionDomain<AtomDomain<T>>

type Imputed = T

This is the type of Self::Carrier after imputation.

fn impute_constant<'a>( default: &'a Self::Carrier, constant: &'a Self::Imputed ) -> &'a Self::Imputed

A function that replaces a potentially-null carrier type with a non-null imputed type.

impl<D: PartialEq + Domain> PartialEq for OptionDomain<D>

fn eq(&self, other: &OptionDomain<D>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<D: Domain> StructuralPartialEq for OptionDomain<D>