opendp.domains module#

opendp.domains.atom_domain(bounds=None, nullable=False, T=None)[source]#

Construct an instance of AtomDomain.

atom_domain in Rust documentation.

Parameters:

  • bounds (Any) –

  • nullable (bool) –

  • T (Type Argument) – The type of the atom.

Raises:

  • TypeError – if an argument’s type differs from the expected type

  • UnknownTypeError – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.domains.domain_carrier_type(this)[source]#

Get the carrier type of a domain.

domain_carrier_type in Rust documentation.

Parameters:

this – The domain to retrieve the carrier type from.

Return type:

str

Raises:

  • TypeError – if an argument’s type differs from the expected type

  • UnknownTypeError – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.domains.domain_debug(this)[source]#

Debug a domain.

domain_debug in Rust documentation.

Parameters:

this – The domain to debug (stringify).

Return type:

str

Raises:

  • TypeError – if an argument’s type differs from the expected type

  • UnknownTypeError – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.domains.domain_type(this)[source]#

Get the type of a domain.

domain_type in Rust documentation.

Parameters:

this – The domain to retrieve the type from.

Return type:

str

Raises:

  • TypeError – if an argument’s type differs from the expected type

  • UnknownTypeError – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.domains.member(this, val)[source]#

Check membership in a domain.

member in Rust documentation.

Parameters:

  • this (Domain) – The domain to check membership in.

  • val (Any) – A potential element of the domain.

Raises:

  • TypeError – if an argument’s type differs from the expected type

  • UnknownTypeError – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.domains.option_domain(element_domain, D=None)[source]#

Construct an instance of OptionDomain.

option_domain in Rust documentation.

Parameters:

  • element_domain –

  • D (Type Argument) – The type of the inner domain.

Raises:

  • TypeError – if an argument’s type differs from the expected type

  • UnknownTypeError – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.domains.vector_domain(atom_domain, size=None)[source]#

Construct an instance of VectorDomain.

vector_domain in Rust documentation.

Parameters:

  • atom_domain – The inner domain.

  • size (Any) –

Raises:

  • TypeError – if an argument’s type differs from the expected type

  • UnknownTypeError – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library