opendp.core module

opendp.core.measurement_check(measurement, distance_in, distance_out)

Check the privacy relation of the measurement at the given d_in, d_out

measurement_check in Rust documentation.

Parameters:

• measurement (Measurement) – Measurement to check the privacy relation of.

• distance_in (Any) –

• distance_out (Any) –

Returns:

True indicates that the relation passed at the given distance.

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.core.measurement_input_carrier_type(this)

Get the input (carrier) data type of this.

measurement_input_carrier_type in Rust documentation.

Parameters:

this (Measurement) – The measurement 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.core.measurement_input_distance_type(this)

Get the input distance type of measurement.

measurement_input_distance_type in Rust documentation.

Parameters:

this (Measurement) – The measurement 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.core.measurement_invoke(this, arg)

Invoke the measurement with arg. Returns a differentially private release.

measurement_invoke in Rust documentation.

Parameters:

• this (Measurement) – Measurement to invoke.

• arg (Any) – Input data to supply to the measurement. A member of the measurement’s input domain.

Return type:

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

opendp.core.measurement_map(measurement, distance_in)

Use the measurement to map a given d_in to d_out.

measurement_map in Rust documentation.

Parameters:

• measurement (Measurement) – Measurement to check the map distances with.

• distance_in (Any) – Distance in terms of the input metric.

Return type:

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

opendp.core.measurement_output_distance_type(this)

Get the output distance type of measurement.

measurement_output_distance_type in Rust documentation.

Parameters:

this (Measurement) – The measurement 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.core.transformation_check(transformation, distance_in, distance_out)

Check the privacy relation of the measurement at the given d_in, d_out

transformation_check in Rust documentation.

Parameters:

• transformation (Transformation) –

• distance_in (Any) –

• distance_out (Any) –

Returns:

True indicates that the relation passed at the given distance.

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.core.transformation_input_carrier_type(this)

Get the input (carrier) data type of this.

transformation_input_carrier_type in Rust documentation.

Parameters:

this (Transformation) – The transformation 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.core.transformation_input_distance_type(this)

Get the input distance type of transformation.

transformation_input_distance_type in Rust documentation.

Parameters:

this (Transformation) – The transformation 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.core.transformation_invoke(this, arg)

Invoke the transformation with arg. Returns a differentially private release.

transformation_invoke in Rust documentation.

Parameters:

• this (Transformation) – Transformation to invoke.

• arg (Any) – Input data to supply to the transformation. A member of the transformation’s input domain.

Return type:

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

opendp.core.transformation_map(transformation, distance_in)

Use the transformation to map a given d_in to d_out.

transformation_map in Rust documentation.

Parameters:

• transformation (Transformation) – Transformation to check the map distances with.

• distance_in (Any) – Distance in terms of the input metric.

Return type:

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

opendp.core.transformation_output_distance_type(this)

Get the output distance type of transformation.

transformation_output_distance_type in Rust documentation.

Parameters:

this (Transformation) – The transformation 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