Merge pull request #122 from bksaiki/refactor

Refactor numbers library

Author: bksaiki

fpy2/number/__init__.py

@@ -1,316 +1,37 @@
-from typing import TypeAlias
+
 
 # Numbers
-from .number import RealFloat, Float, Real
+from .number import Float, RealFloat, Real
 
 # Contexts
-from .context import Context, OrdinalContext, SizedContext, EncodableContext
-from .exponential import ExpContext
-from .efloat import EFloatContext, EFloatNanKind
-from .fixed import FixedContext
-from .ieee754 import IEEEContext
-from .mp_fixed import MPFixedContext
-from .mp_float import MPFloatContext
-from .mpb_fixed import MPBFixedContext
-from .mpb_float import MPBFloatContext
-from .mps_float import MPSFloatContext
-from .real import RealContext, REAL
-from .sm_fixed import SMFixedContext
+from .context import (
+    # abstract contexts
+    Context, OrdinalContext, SizedContext, EncodableContext,
+    # concrete contexts
+    ExpContext,
+    EFloatContext, EFloatNanKind,
+    FixedContext,
+    IEEEContext,
+    MPFixedContext,
+    MPFloatContext,
+    MPBFixedContext,
+    MPBFloatContext,
+    MPSFloatContext,
+    RealContext,
+    SMFixedContext,
+    # context instances
+    FP256, FP128, FP64, FP32, FP16,
+    TF32, BF16,
+    S1E5M2, S1E4M3,
+    MX_E5M2, MX_E4M3, MX_E3M2, MX_E2M3, MX_E2M1, MX_E8M0, MX_INT8,
+    FP8P1, FP8P2, FP8P3, FP8P4, FP8P5, FP8P6, FP8P7,
+    SINT8, SINT16, SINT32, SINT64,
+    UINT8, UINT16, UINT32, UINT64,
+    INTEGER, REAL,
+)
 
 # Rounding
-from .round import RoundingMode, RoundingDirection, OverflowMode
+from .round import RoundingMode, RoundingDirection, OverflowMode, RM, OV
 
 # Miscellaneous
 from .native import default_float_convert, default_str_convert
-
-###########################################################
-# Type aliases
-
-RM: TypeAlias = RoundingMode
-"""alias for `RoundingMode`"""
-
-OV: TypeAlias = OverflowMode
-"""alias for `OverflowMode`"""
-
-###########################################################
-# Format aliases
-
-FP256 = IEEEContext(19, 256, RM.RNE)
-"""
-Alias for the IEEE 754 octuple precision (256-bit) floating point format
-with round nearest, ties-to-even rounding mode.
-"""
-
-FP128 = IEEEContext(15, 128, RM.RNE)
-"""
-Alias for the IEEE 754 quadruple precision (128-bit) floating point format
-with round nearest, ties-to-even rounding mode.
-"""
-
-FP64 = IEEEContext(11, 64, RM.RNE)
-"""
-Alias for the IEEE 754 double precision (64-bit) floating point format
-with round nearest, ties-to-even rounding mode.
-
-This context is Python's native float type.
-"""
-
-FP32 = IEEEContext(8, 32, RM.RNE)
-"""
-Alias for the IEEE 754 single precision (32-bit) floating point format
-with round nearest, ties-to-even rounding mode.
-"""
-
-FP16 = IEEEContext(5, 16, RM.RNE)
-"""
-Alias for the IEEE 754 half precision (16-bit) floating point format
-with round nearest, ties-to-even rounding mode.
-"""
-
-TF32 = IEEEContext(8, 19, RM.RNE)
-"""
-Alias for Nvidia's TensorFloat-32 (TF32) floating point format
-with round nearest, ties-to-even rounding mode.
-"""
-
-BF16 = IEEEContext(8, 16, RM.RNE)
-"""
-Alias for Google's Brain Floating Point (BF16) floating point format
-with round nearest, ties-to-even rounding mode.
-"""
-
-S1E5M2 = EFloatContext(5, 8, False, EFloatNanKind.NEG_ZERO, -1, RM.RNE)
-"""
-Alias for Graphcore's FP8 format with 5 bits of exponent
-with round nearest, ties-to-even rounding mode.
-
-See Graphcore's FP8 proposal for more information: https://arxiv.org/pdf/2206.02915.
-"""
-
-S1E4M3 = EFloatContext(4, 8, False, EFloatNanKind.NEG_ZERO, -1, RM.RNE)
-"""
-Alias for Graphcore's FP8 format with 4 bits of exponent
-with round nearest, ties-to-even rounding mode.
-
-See Graphcore's FP8 proposal for more information: https://arxiv.org/pdf/2206.02915.
-"""
-
-MX_E5M2 = IEEEContext(5, 8, RM.RNE)
-"""
-Alias for the FP8 format with 5 bits of exponent in
-the Open Compute Project (OCP) Microscaling Formats (MX) specification
-with round nearest, ties-to-even rounding mode.
-
-See the OCP MX specification for more information:
-https://www.opencompute.org/documents/ocp-microscaling-formats-mx-v1-0-spec-final-pdf
-"""
-
-MX_E4M3 = EFloatContext(4, 8, False, EFloatNanKind.MAX_VAL, 0, RM.RNE)
-"""
-Alias for the FP8 format with 4 bits of exponent in
-the Open Compute Project (OCP) Microscaling Formats (MX) specification
-with round nearest, ties-to-even rounding mode.
-
-See the OCP MX specification for more information:
-https://www.opencompute.org/documents/ocp-microscaling-formats-mx-v1-0-spec-final-pdf
-"""
-
-MX_E3M2 = EFloatContext(3, 6, False, EFloatNanKind.NONE, 0, RM.RNE)
-"""
-Alias for the FP6 format with 3 bits of exponent in
-the Open Compute Project (OCP) Microscaling Formats (MX) specification
-with round nearest, ties-to-even rounding mode.
-
-See the OCP MX specification for more information:
-https://www.opencompute.org/documents/ocp-microscaling-formats-mx-v1-0-spec-final-pdf
-"""
-
-MX_E2M3 = EFloatContext(2, 6, False, EFloatNanKind.NONE, 0, RM.RNE)
-"""
-Alias for the FP6 format with 2 bits of exponent in
-the Open Compute Project (OCP) Microscaling Formats (MX) specification
-with round nearest, ties-to-even rounding mode.
-
-See the OCP MX specification for more information:
-https://www.opencompute.org/documents/ocp-microscaling-formats-mx-v1-0-spec-final-pdf
-"""
-
-MX_E2M1 = EFloatContext(2, 4, False, EFloatNanKind.NONE, 0, RM.RNE)
-"""
-Alias for the FP4 format with 2 bits of exponent in
-the Open Compute Project (OCP) Microscaling Formats (MX) specification
-with round nearest, ties-to-even rounding mode.
-
-See the OCP MX specification for more information:
-https://www.opencompute.org/documents/ocp-microscaling-formats-mx-v1-0-spec-final-pdf
-"""
-
-MX_E8M0 = ExpContext(8, 0)
-"""
-Alias for the MX scaling format in the Open Compute Project (OCP)
-Microscaling Formats (MX) specification with round nearest, ties-to-even
-rounding mode.
-
-This is just the exponent field of a single-precision floating-point value (`FP32`)
-with `encode(x) == 0xFF` representing NaN and `encode(x) == 0x00` representing
-the exponent one below the minimum normal exponent value.
-"""
-
-MX_INT8 = FixedContext(True, -6, 8, RM.RNE)
-"""
-Alias for the MX 8-bit integer format in the Open Compute Project (OCP)
-Microscaling Formats (MX) specification with round nearest, ties-to-even
-rounding mode.
-
-This implementation uses the standard asymmetric encoding inherited
-from fixed-point formats, with `+MAX_VAL = +1 63/64` and `-MAX_VAL = -2`.
-"""
-
-FP8P1 = EFloatContext(7, 8, True, EFloatNanKind.NEG_ZERO, 0, RM.RNE)
-"""
-Alias for the FP8 format with 7 bits of exponent found in
-a draft proposal by the IEEE P3109 working group
-with round nearest, ties-to-even rounding mode.
-Format subject to change.
-
-See the IEEE P3109 working group for more information:
-https://github.com/P3109/Public/blob/main/IEEE%20WG%20P3109%20Interim%20Report.pdf
-"""
-
-FP8P2 = EFloatContext(6, 8, True, EFloatNanKind.NEG_ZERO, -1, RM.RNE)
-"""
-Alias for the FP8 format with 6 bits of exponent found in
-a draft proposal by the IEEE P3109 working group
-with round nearest, ties-to-even rounding mode.
-Format subject to change.
-
-See the IEEE P3109 working group for more information:
-https://github.com/P3109/Public/blob/main/IEEE%20WG%20P3109%20Interim%20Report.pdf
-"""
-
-FP8P3 = EFloatContext(5, 8, True, EFloatNanKind.NEG_ZERO, -1, RM.RNE)
-"""
-Alias for the FP8 format with 5 bits of exponent found in
-a draft proposal by the IEEE P3109 working group
-with round nearest, ties-to-even rounding mode.
-Format subject to change.
-
-See the IEEE P3109 working group for more information:
-https://github.com/P3109/Public/blob/main/IEEE%20WG%20P3109%20Interim%20Report.pdf
-"""
-
-FP8P4 = EFloatContext(4, 8, True, EFloatNanKind.NEG_ZERO, -1, RM.RNE)
-"""
-Alias for the FP8 format with 4 bits of exponent found in
-a draft proposal by the IEEE P3109 working group
-with round nearest, ties-to-even rounding mode.
-Format subject to change.
-
-See the IEEE P3109 working group for more information:
-https://github.com/P3109/Public/blob/main/IEEE%20WG%20P3109%20Interim%20Report.pdf
-"""
-
-FP8P5 = EFloatContext(3, 8, True, EFloatNanKind.NEG_ZERO, -1, RM.RNE)
-"""
-Alias for the FP8 format with 3 bits of exponent found in
-a draft proposal by the IEEE P3109 working group
-with round nearest, ties-to-even rounding mode.
-Format subject to change.
-
-See the IEEE P3109 working group for more information:
-https://github.com/P3109/Public/blob/main/IEEE%20WG%20P3109%20Interim%20Report.pdf
-"""
-
-FP8P6 = EFloatContext(2, 8, True, EFloatNanKind.NEG_ZERO, -1, RM.RNE)
-"""
-Alias for the FP8 format with 2 bits of exponent found in
-a draft proposal by the IEEE P3109 working group
-with round nearest, ties-to-even rounding mode.
-Format subject to change.
-
-See the IEEE P3109 working group for more information:
-https://github.com/P3109/Public/blob/main/IEEE%20WG%20P3109%20Interim%20Report.pdf
-"""
-
-FP8P7 = EFloatContext(1, 8, True, EFloatNanKind.NEG_ZERO, -1, RM.RNE)
-"""
-Alias for the FP8 format with 1 bit of exponent found in
-a draft proposal by the IEEE P3109 working group
-with round nearest, ties-to-even rounding mode.
-Format subject to change.
-
-See the IEEE P3109 working group for more information:
-https://github.com/P3109/Public/blob/main/IEEE%20WG%20P3109%20Interim%20Report.pdf
-"""
-
-INTEGER = MPFixedContext(-1, RoundingMode.RTZ)
-"""
-Alias for an arbitrary-precision integer context with
-round towards zero rounding mode.
-
-Numbers rounded under this context behave like Python's native `int` type.
-"""
-
-SINT8 = FixedContext(True, 0, 8, RM.RTZ, OV.WRAP)
-"""
-Alias for a signed 8-bit integer context with
-round towards zero rounding mode and wrapping overflow behavior.
-
-Rounding infinity or NaN under this context produces an OverflowError.
-"""
-
-SINT16 = FixedContext(True, 0, 16, RM.RTZ, OV.WRAP)
-"""
-Alias for a signed 16-bit integer context with
-round towards zero rounding mode and wrapping overflow behavior.
-
-Rounding infinity or NaN under this context produces an OverflowError.
-"""
-
-SINT32 = FixedContext(True, 0, 32, RM.RTZ, OV.WRAP)
-"""
-Alias for a signed 32-bit integer context with
-round towards zero rounding mode and wrapping overflow behavior.
-
-Rounding infinity or NaN under this context produces an OverflowError.
-"""
-
-SINT64 = FixedContext(True, 0, 64, RM.RTZ, OV.WRAP)
-"""
-Alias for a signed 64-bit integer context with
-round towards zero rounding mode and wrapping overflow behavior.
-
-Rounding infinity or NaN under this context produces an OverflowError.
-"""
-
-UINT8 = FixedContext(False, 0, 8, RM.RTZ, OV.WRAP)
-"""
-Alias for an unsigned 8-bit integer context with
-round towards zero rounding mode and wrapping overflow behavior.
-
-Rounding infinity or NaN under this context produces an OverflowError.
-"""
-
-UINT16 = FixedContext(False, 0, 16, RM.RTZ, OV.WRAP)
-"""
-Alias for an unsigned 16-bit integer context with
-round towards zero rounding mode and wrapping overflow behavior.
-
-Rounding infinity or NaN under this context produces an OverflowError.
-"""
-
-UINT32 = FixedContext(False, 0, 32, RM.RTZ, OV.WRAP)
-"""
-Alias for an unsigned 32-bit integer context with
-round towards zero rounding mode and wrapping overflow behavior.
-
-Rounding infinity or NaN under this context produces an OverflowError.
-"""
-
-UINT64 = FixedContext(False, 0, 64, RM.RTZ, OV.WRAP)
-"""
-Alias for an unsigned 64-bit integer context with
-round towards zero rounding mode and wrapping overflow behavior.
-
-Rounding infinity or NaN under this context produces an OverflowError.
-"""