Source code for Muscat.Types

#
# This file is subject to the terms and conditions defined in
# file 'LICENSE.txt', which is part of this source code package.
#

import sys
from typing import Union

""" Developer Documentation:
A change of the type in this files must be coherent with the types in :
    CythonTypes.pxd and EigenTypes.h
"""

if sys.platform == "win32":  # only nt coverage
    from numpy import int32
    MuscatIndex = int32
else:  # only posix coverage
    from numpy import int64
    MuscatIndex = int64
    """Type for the ints in Muscat.
    originalIDs, connectivity matrix and indices for example.
    """


from numpy import float64

MuscatFloat = float64
"""Type for the floats in Muscat.
fields values and point positions for example.
"""
from numpy.typing import ArrayLike, NDArray

ScalarIntLike = Union[int, MuscatIndex]
"""MetaType for typing int like arguments
"""


[docs]def CheckIntegrity(GUI: bool = False) -> str:
    return "ok"