openfisca_core.indexed_enums.
Enum
(name)[source]¶Enum based on enum34, whose items have an index.
encode
(array)[source]¶Encode a string numpy array, or an enum item numpy array, into an EnumArray
. See EnumArray.decode
for decoding.
Parameters: | array (numpy.ndarray) – Numpy array of string identifiers, or of enum items, to encode. |
---|---|
Returns: | An EnumArray encoding the input array values. |
Return type: | EnumArray |
For instance:
>>> string_identifier_array = numpy.asarray(['free_lodger', 'owner'])
>>> encoded_array = HousingOccupancyStatus.encode(string_identifier_array)
>>> encoded_array[0]
>>> 2 # Encoded value
>>> enum_item_array = numpy.asarray([HousingOccupancyStatus.free_lodger, HousingOccupancyStatus.owner])
>>> encoded_array = HousingOccupancyStatus.encode(enum_item_array)
>>> encoded_array[0]
>>> 2 # Encoded value