citrine.informatics.constraints.scalar_range_constraint module

class citrine.informatics.constraints.scalar_range_constraint.ScalarRangeConstraint(*, descriptor_key: str, lower_bound: float | None = None, upper_bound: float | None = None, lower_inclusive: bool | None = None, upper_inclusive: bool | None = None)

Bases: Serializable[ScalarRangeConstraint], Constraint

Represents an inequality constraint on a real-valued material attribute.

Parameters:

• descriptor_key (str) – the key corresponding to a descriptor

• lower_bound (float) – the minimum value in the range

• upper_bound (float) – the maximum value in the range

• lower_inclusive (bool) – if True, will include the lower bound value in the range (default: true)

• upper_inclusive (bool) – if True, will include the max value in the range (default: true)

classmethod build(data: dict) → Self

Build an instance of this object from given data.

dump() → dict

Dump this instance.

classmethod get_type(data)

Return the subtype.

descriptor_key = None

lower_bound = None

lower_inclusive = None

typ = 'ScalarRange'

upper_bound = None

upper_inclusive = None