Skip to content

foapy.ma.alphabet

alphabet(X)

Implementation of ordered set - alphabet of elements. Alphabet is list of all unique elements in particular sequence.

Parameters:

Name Type Description Default

X

Array to get unique values.

 required

Returns:

Name Type Description
result masked_array or Exception.

Exception if wrong mask or not d1 array, masked_array otherwise.

Examples:

----1----

>>> import foapy.ma as ma
>>> a = ['a', 'c', 'c', 'e', 'd', 'a']
>>> mask = [0, 0, 0, 1, 0, 0]
>>> masked_a = ma.masked_array(a, mask)
>>> b = ma.alphabet(masked_a)
>>> b
['a' 'c' 'd']

----2----

>>> import foapy.ma as ma
>>> a = ['a', 'c', 'c', 'e', 'd', 'a']
>>> mask = [0, 0, 0, 0, 0, 0]
>>> masked_a = ma.masked_array(a, mask)
>>> b = ma.alphabet(masked_a)
>>> b
['a' 'c' 'e' 'd']

----3----

>>> import foapy.ma as ma
>>> a = [1, 2, 2, 3, 4, 1]
>>> mask = [0, 0, 0, 0, 0, 0]
>>> masked_a = ma.masked_array(a, mask)
>>> b = ma.alphabet(masked_a)
>>> b
[1 2 3 4]

----4----

>>> import foapy.ma as ma
>>> a = []
>>> mask = []
>>> masked_a = ma.masked_array(a, mask)
>>> b = ma.alphabet(masked_a)
>>> b
[]

----5----

>>> import foapy.ma as ma
>>> a = ['a', 'b', 'c', 'a', 'b', 'c', 'c', 'c', 'b', 'a', 'c', 'b', 'c']
>>> mask = [0, 1, 0, 0, 1, 0, 0, 0, 1, 0, 0, 1, 0]
>>> masked_a = ma.masked_array(a, mask)
>>> b = ma.alphabet(masked_a)
>>> b
['а' 'c']

----6----

>>> import foapy.ma as ma
>>> a = ['a', 'b', 'c', 'a', 'b', 'c', 'c', 'c', 'b', 'a', 'c', 'b', 'c']
>>> mask = [0, 1, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1]
>>> masked_a = ma.masked_array(a, mask)
>>> b = ma.alphabet(masked_a)
>>> b
['а']

----7----

>>> import foapy.ma as ma
>>> a = ['a', 'b', 'c', 'a', 'b', 'c', 'c', 'c', 'b', 'a', 'c', 'b', 'c']
>>> mask = [0, 1, 0, 0, 0, 0, 0, 0, 1, 0, 0, 1, 0]
>>> masked_a = ma.masked_array(a, mask)
>>> b = ma.alphabet(masked_a)
>>> b
Exception

----8----

>>> import foapy.ma as ma
>>> a = [[2, 2, 2], [2, 2, 2]]
>>> mask = [[0, 0, 0], [0, 0, 0]]
>>> masked_a = ma.masked_array(a, mask)
>>> b = ma.alphabet(masked_a)
>>> b
Exception
Source code in .tox/docs-deploy/lib/python3.11/site-packages/foapy/ma/_alphabet.py 
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def alphabet(X) -> np.ma.MaskedArray:
    """
    Implementation of ordered set - alphabet of elements.
    Alphabet is list of all unique elements in particular sequence.

    Parameters
    ----------
    X: masked_array
        Array to get unique values.

    Returns
    -------
    result: masked_array or Exception.
        Exception if wrong mask or not d1 array, masked_array otherwise.

    Examples
    --------

    ----1----
    >>> import foapy.ma as ma
    >>> a = ['a', 'c', 'c', 'e', 'd', 'a']
    >>> mask = [0, 0, 0, 1, 0, 0]
    >>> masked_a = ma.masked_array(a, mask)
    >>> b = ma.alphabet(masked_a)
    >>> b
    ['a' 'c' 'd']

    ----2----
    >>> import foapy.ma as ma
    >>> a = ['a', 'c', 'c', 'e', 'd', 'a']
    >>> mask = [0, 0, 0, 0, 0, 0]
    >>> masked_a = ma.masked_array(a, mask)
    >>> b = ma.alphabet(masked_a)
    >>> b
    ['a' 'c' 'e' 'd']

    ----3----
    >>> import foapy.ma as ma
    >>> a = [1, 2, 2, 3, 4, 1]
    >>> mask = [0, 0, 0, 0, 0, 0]
    >>> masked_a = ma.masked_array(a, mask)
    >>> b = ma.alphabet(masked_a)
    >>> b
    [1 2 3 4]

    ----4----
    >>> import foapy.ma as ma
    >>> a = []
    >>> mask = []
    >>> masked_a = ma.masked_array(a, mask)
    >>> b = ma.alphabet(masked_a)
    >>> b
    []

    ----5----
    >>> import foapy.ma as ma
    >>> a = ['a', 'b', 'c', 'a', 'b', 'c', 'c', 'c', 'b', 'a', 'c', 'b', 'c']
    >>> mask = [0, 1, 0, 0, 1, 0, 0, 0, 1, 0, 0, 1, 0]
    >>> masked_a = ma.masked_array(a, mask)
    >>> b = ma.alphabet(masked_a)
    >>> b
    ['а' 'c']

    ----6----
    >>> import foapy.ma as ma
    >>> a = ['a', 'b', 'c', 'a', 'b', 'c', 'c', 'c', 'b', 'a', 'c', 'b', 'c']
    >>> mask = [0, 1, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1]
    >>> masked_a = ma.masked_array(a, mask)
    >>> b = ma.alphabet(masked_a)
    >>> b
    ['а']

    ----7----
    >>> import foapy.ma as ma
    >>> a = ['a', 'b', 'c', 'a', 'b', 'c', 'c', 'c', 'b', 'a', 'c', 'b', 'c']
    >>> mask = [0, 1, 0, 0, 0, 0, 0, 0, 1, 0, 0, 1, 0]
    >>> masked_a = ma.masked_array(a, mask)
    >>> b = ma.alphabet(masked_a)
    >>> b
    Exception

    ----8----
    >>> import foapy.ma as ma
    >>> a = [[2, 2, 2], [2, 2, 2]]
    >>> mask = [[0, 0, 0], [0, 0, 0]]
    >>> masked_a = ma.masked_array(a, mask)
    >>> b = ma.alphabet(masked_a)
    >>> b
    Exception
    """

    if X.ndim > 1:  # Checking for d1 array
        raise Not1DArrayException(
            {"message": f"Incorrect array form. Expected d1 array, exists {X.ndim}"}
        )

    mask = ma.getmask(X)
    perm = X.argsort(kind="mergesort")

    mask_shape = X.shape
    unique_mask = np.empty(mask_shape, dtype=bool)
    unique_mask[:1] = True
    unique_mask[1:] = X[perm[1:]] != X[perm[:-1]]
    unique_mask = np.logical_and(unique_mask, ~mask[perm])

    result_mask = np.full_like(unique_mask, False)
    result_mask[perm[unique_mask]] = True
    return X[result_mask]