This documentation is for an old version of OpenDP.

The current release of OpenDP is v0.11.1.

opendp.core module#

The core module provides functions for accessing the fields of transformations and measurements.

opendp.core.function_eval(this, arg, TI=None)[source]#

Eval the function with arg.

Parameters:

  • this (Function) – Function to invoke.

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

  • TI (str) – Input Type.

Return type:

Any

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.measurement_check(measurement, distance_in, distance_out)[source]#

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

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.measurement_function(this)[source]#

Get the function from a measurement.

Parameters:

this (Measurement) – The measurement to retrieve the value from.

Return type:

Function

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.measurement_input_carrier_type(this)[source]#

Get the input (carrier) data type of this.

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.measurement_input_distance_type(this)[source]#

Get the input distance type of measurement.

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.measurement_input_domain(this)[source]#

Get the input domain from a measurement.

Parameters:

this (Measurement) – The measurement to retrieve the value from.

Return type:

Domain

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.measurement_input_metric(this)[source]#

Get the input domain from a measurement.

Parameters:

this (Measurement) – The measurement to retrieve the value from.

Return type:

Metric

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.measurement_invoke(this, arg)[source]#

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

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.measurement_map(measurement, distance_in)[source]#

Use the measurement to map a given d_in to d_out.

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.measurement_output_distance_type(this)[source]#

Get the output distance type of measurement.

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.measurement_output_measure(this)[source]#

Get the output domain from a measurement.

Parameters:

this (Measurement) – The measurement to retrieve the value from.

Return type:

Measure

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.new_function(function, TO)[source]#

Construct a Function from a user-defined callback. Can be used as a post-processing step.

Parameters:

  • function – A function mapping data to a value of type TO

  • TO (Type Argument) – Output Type

Return type:

Function

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.new_queryable(transition, Q='ExtrinsicObject', A='ExtrinsicObject')[source]#

Construct a queryable from a user-defined transition function.

Parameters:

  • transition – A transition function taking a reference to self, a query, and an internal/external indicator

  • Q (Type Argument) – Query Type

  • A (Type Argument) – Output Type

Return type:

Any

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.queryable_eval(queryable, query)[source]#

Invoke the queryable with query. Returns a differentially private release.

Parameters:

  • queryable (Any) – Queryable to eval.

  • query (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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.queryable_query_type(this)[source]#

Get the query type of queryable.

Parameters:

this (Any) – The queryable to retrieve the query type from.

Return type:

str

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_check(transformation, distance_in, distance_out)[source]#

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

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_function(this)[source]#

Get the function from a transformation.

Parameters:

this (Transformation) – The transformation to retrieve the value from.

Return type:

Function

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_input_carrier_type(this)[source]#

Get the input (carrier) data type of this.

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_input_distance_type(this)[source]#

Get the input distance type of transformation.

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_input_domain(this)[source]#

Get the input domain from a transformation.

Parameters:

this (Transformation) – The transformation to retrieve the value from.

Return type:

Domain

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_input_metric(this)[source]#

Get the input domain from a transformation.

Parameters:

this (Transformation) – The transformation to retrieve the value from.

Return type:

Metric

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_invoke(this, arg)[source]#

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

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_map(transformation, distance_in)[source]#

Use the transformation to map a given d_in to d_out.

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_output_distance_type(this)[source]#

Get the output distance type of transformation.

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_output_domain(this)[source]#

Get the output domain from a transformation.

Parameters:

this (Transformation) – The transformation to retrieve the value from.

Return type:

Domain

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

opendp.core.transformation_output_metric(this)[source]#

Get the output domain from a transformation.

Parameters:

this (Transformation) – The transformation to retrieve the value from.

Return type:

Metric

Raises:

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

  • UnknownTypeException – if a type argument fails to parse

  • OpenDPException – packaged error from the core OpenDP library

On this page
Show Source