|
1 | | -# Copyright (C) 2023 ANSYS, Inc. and/or its affiliates. |
2 | | -# SPDX-License-Identifier: MIT |
3 | | -# |
4 | | -# |
5 | | -# Permission is hereby granted, free of charge, to any person obtaining a copy |
6 | | -# of this software and associated documentation files (the "Software"), to deal |
7 | | -# in the Software without restriction, including without limitation the rights |
8 | | -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
9 | | -# copies of the Software, and to permit persons to whom the Software is |
10 | | -# furnished to do so, subject to the following conditions: |
11 | | -# |
12 | | -# The above copyright notice and this permission notice shall be included in all |
13 | | -# copies or substantial portions of the Software. |
14 | | -# |
15 | | -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
16 | | -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
17 | | -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
18 | | -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
19 | | -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
20 | | -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
21 | | -# SOFTWARE. |
22 | | -"""Provides typing of values for PyAnsys Geometry.""" |
23 | | - |
24 | | -from beartype.typing import Sequence, Union |
25 | | -import numpy as np |
26 | | - |
27 | | -Real = Union[int, float, np.integer, np.floating] |
28 | | -"""Type used to refer to both integers and floats as possible values.""" |
29 | | - |
30 | | -RealSequence = Union[np.ndarray, Sequence[Real]] |
31 | | -""" |
32 | | -Type used to refer to ``Real`` types as a ``Sequence`` type. |
33 | | -
|
34 | | -Notes |
35 | | ------ |
36 | | -:class:`numpy.ndarrays <numpy.ndarray>` are also accepted because they are |
37 | | -the overlaying data structure behind most PyAnsys Geometry objects. |
38 | | -""" |
| 1 | +# Copyright (C) 2023 ANSYS, Inc. and/or its affiliates. |
| 2 | +# SPDX-License-Identifier: MIT |
| 3 | +# |
| 4 | +# |
| 5 | +# Permission is hereby granted, free of charge, to any person obtaining a copy |
| 6 | +# of this software and associated documentation files (the "Software"), to deal |
| 7 | +# in the Software without restriction, including without limitation the rights |
| 8 | +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 9 | +# copies of the Software, and to permit persons to whom the Software is |
| 10 | +# furnished to do so, subject to the following conditions: |
| 11 | +# |
| 12 | +# The above copyright notice and this permission notice shall be included in all |
| 13 | +# copies or substantial portions of the Software. |
| 14 | +# |
| 15 | +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 16 | +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 17 | +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 18 | +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 19 | +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 20 | +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 21 | +# SOFTWARE. |
| 22 | +"""Provides typing of values for PyAnsys Geometry.""" |
| 23 | + |
| 24 | +from beartype.typing import Sequence, Union |
| 25 | +import numpy as np |
| 26 | + |
| 27 | +Real = Union[int, float, np.integer, np.floating] |
| 28 | +"""Type used to refer to both integers and floats as possible values.""" |
| 29 | + |
| 30 | +RealSequence = Union[np.ndarray, Sequence[Real]] |
| 31 | +""" |
| 32 | +Type used to refer to ``Real`` types as a ``Sequence`` type. |
| 33 | +
|
| 34 | +Notes |
| 35 | +----- |
| 36 | +:class:`numpy.ndarrays <numpy.ndarray>` are also accepted because they are |
| 37 | +the overlaying data structure behind most PyAnsys Geometry objects. |
| 38 | +""" |
0 commit comments