ucon 0.3.3rc1__py3-none-any.whl → 0.3.4__py3-none-any.whl

ucon/dimension.py

@@ -1,172 +0,0 @@
-"""
-ucon.dimension
-===============
-
-Defines the algebra of **physical dimensions**--the foundation of all unit
-relationships and dimensional analysis in *ucon*.
-
-Each :class:`Dimension` represents a physical quantity (time, mass, length, etc.)
-expressed as a 7-element exponent vector following the SI base system:
-
-    (T, L, M, I, Θ, J, N) :: (s * m * kg * A * K * cd * mol)
-     time, length, mass, current, temperature, luminous intensity, substance
-
-Derived dimensions are expressed as algebraic sums or differences of these base
-vectors (e.g., `velocity = length / time`, `force = mass * acceleration`).
-
-Classes
--------
-- :class:`Vector` — Represents the exponent vector of a physical quantity.
-- :class:`Dimension` — Enum of known physical quantities, each with a `Vector`
-  value and operator overloads for dimensional algebra.
-"""
-from dataclasses import dataclass
-from enum import Enum
-from functools import partial, reduce
-from operator import __sub__ as subtraction
-from typing import Callable, Iterable, Iterator
-
-
-diff: Callable[[Iterable], int] = partial(reduce, subtraction)
-
-@dataclass
-class Vector:
-    """
-    Represents the **exponent vector** of a physical quantity.
-
-    Each component corresponds to the power of a base dimension in the SI system:
-    time (T), length (L), mass (M), current (I), temperature (Θ),
-    luminous intensity (J), and amount of substance (N).
-
-    Arithmetic operations correspond to dimensional composition:
-    - Addition (`+`) → multiplication of quantities
-    - Subtraction (`-`) → division of quantities
-
-    e.g.
-    Vector(T=1, L=0, M=0, I=0, Θ=0, J=0, N=0)   => "time"
-    Vector(T=0, L=2, M=0, I=0, Θ=0, J=0, N=0)   => "area"
-    Vector(T=-2, L=1, M=1, I=0, Θ=0, J=0, N=0)  => "force"
-    """
-    T: int = 0  # time
-    L: int = 0  # length
-    M: int = 0  # mass
-    I: int = 0  # current
-    Θ: int = 0  # temperature
-    J: int = 0  # luminous intensity
-    N: int = 0  # amount of substance
-
-    def __iter__(self) -> Iterator[int]:
-        yield self.T
-        yield self.L
-        yield self.M
-        yield self.I
-        yield self.Θ
-        yield self.J
-        yield self.N
-
-    def __len__(self) -> int:
-        return sum(tuple(1 for x in self))
-
-    def __add__(self, vector: 'Vector') -> 'Vector':
-        """
-        Addition, here, comes from the multiplication of base quantities
-
-        e.g. F = m * a
-        F =
-            (s^-2 * m^1 * kg   * A * K * cd * mol) +
-            (s    * m   * kg^1 * A * K * cd * mol)
-        """
-        values = tuple(sum(pair) for pair in zip(tuple(self), tuple(vector)))
-        return Vector(*values)
-
-    def __sub__(self, vector: 'Vector') -> 'Vector':
-        """
-        Subtraction, here, comes from the division of base quantities
-        """
-        values = tuple(diff(pair) for pair in zip(tuple(self), tuple(vector)))
-        return Vector(*values)
-
-    def __eq__(self, vector: 'Vector') -> bool:
-        assert isinstance(vector, Vector), "Can only compare Vector to another Vector"
-        return tuple(self) == tuple(vector)
-
-    def __hash__(self) -> int:
-        # Hash based on the string because tuples have been shown to collide
-        # Not the most performant, but effective
-        return hash(str(tuple(self)))
-
-
-class Dimension(Enum):
-    """
-    Represents a **physical dimension** defined by a :class:`Vector`.
-
-    Each dimension corresponds to a distinct combination of base exponents.
-    Dimensions are algebraically composable via multiplication and division:
-
-        >>> Dimension.length / Dimension.time
-        <Dimension.velocity: Vector(T=-1, L=1, M=0, I=0, Θ=0, J=0, N=0)>
-
-    This algebra forms the foundation for unit compatibility and conversion.
-    """
-    none = Vector()
-
-    # -- BASIS ---------------------------------------
-    time                = Vector(1, 0, 0, 0, 0, 0, 0)
-    length              = Vector(0, 1, 0, 0, 0, 0, 0)
-    mass                = Vector(0, 0, 1, 0, 0, 0, 0)
-    current             = Vector(0, 0, 0, 1, 0, 0, 0)
-    temperature         = Vector(0, 0, 0, 0, 1, 0, 0)
-    luminous_intensity  = Vector(0, 0, 0, 0, 0, 1, 0)
-    amount_of_substance = Vector(0, 0, 0, 0, 0, 0, 1)
-    # ------------------------------------------------
-
-    acceleration = Vector(-2, 1, 0, 0, 0, 0, 0)
-    angular_momentum = Vector(-1, 2, 1, 0, 0, 0, 0)
-    area = Vector(0, 2, 0, 0, 0, 0, 0)
-    capacitance = Vector(4, -2, -1, 2, 0, 0, 0)
-    charge = Vector(1, 0, 0, 1, 0, 0, 0)
-    conductance = Vector(3, -2, -1, 2, 0, 0, 0)
-    conductivity = Vector(3, -3, -1, 2, 0, 0, 0)
-    density = Vector(0, -3, 1, 0, 0, 0, 0)
-    electric_field_strength = Vector(-3, 1, 1, -1, 0, 0, 0)
-    energy = Vector(-2, 2, 1, 0, 0, 0, 0)
-    entropy = Vector(-2, 2, 1, 0, -1, 0, 0)
-    force = Vector(-2, 1, 1, 0, 0, 0, 0)
-    frequency = Vector(-1, 0, 0, 0, 0, 0, 0)
-    gravitation = Vector(-2, 3, -1, 0, 0, 0, 0)
-    illuminance = Vector(0, -2, 0, 0, 0, 1, 0)
-    inductance = Vector(-2, 2, 1, -2, 0, 0, 0)
-    magnetic_flux = Vector(-2, 2, 1, -1, 0, 0, 0)
-    magnetic_flux_density = Vector(-2, 0, 1, -1, 0, 0, 0)
-    magnetic_permeability = Vector(-2, 1, 1, -2, 0, 0, 0)
-    molar_mass = Vector(0, 0, 1, 0, 0, 0, -1)
-    molar_volume = Vector(0, 3, 0, 0, 0, 0, -1)
-    momentum = Vector(-1, 1, 1, 0, 0, 0, 0)
-    permittivity = Vector(4, -3, -1, 2, 0, 0, 0)
-    power = Vector(-3, 2, 1, 0, 0, 0, 0)
-    pressure = Vector(-2, -1, 1, 0, 0, 0, 0)
-    resistance = Vector(-3, 2, 1, -2, 0, 0, 0)
-    resistivity = Vector(-3, 3, 1, -2, 0, 0, 0)
-    specific_heat_capacity = Vector(-2, 2, 0, 0, -1, 0, 0)
-    thermal_conductivity = Vector(-3, 1, 1, 0, -1, 0, 0)
-    velocity = Vector(-1, 1, 0, 0, 0, 0, 0)
-    voltage = Vector(-3, 2, 1, -1, 0, 0, 0)
-    volume = Vector(0, 3, 0, 0, 0, 0, 0)
-
-    def __truediv__(self, dimension: 'Dimension') -> 'Dimension':
-        if not isinstance(dimension, Dimension):
-            raise TypeError(f"Cannot divide Dimension by non-Dimension type: {type(dimension)}")
-        return Dimension(self.value - dimension.value)
-
-    def __mul__(self, dimension: 'Dimension') -> 'Dimension':
-        if not isinstance(dimension, Dimension):
-            raise TypeError(f"Cannot multiply Dimension by non-Dimension type: {type(dimension)}")
-        return Dimension(self.value + dimension.value)
-
-    def __eq__(self, dimension) -> bool:
-        if not isinstance(dimension, Dimension):
-            raise TypeError(f"Cannot compare Dimension with non-Dimension type: {type(dimension)}")
-        return self.value == dimension.value
-
-    def __hash__(self) -> int:
-        return hash(self.value)

ucon/unit.py

@@ -1,92 +0,0 @@
-"""
-ucon.unit
-==========
-
-Defines the **Unit** abstraction — the symbolic and algebraic representation of
-a measurable quantity associated with a :class:`ucon.dimension.Dimension`.
-
-A :class:`Unit` pairs a human-readable name and aliases with its underlying
-dimension.
-
-Units are composable:
-
-    >>> from ucon import units
-    >>> units.meter / units.second
-    <velocity | (m/s)>
-
-They can be multiplied or divided to form compound units, and their dimensional
-relationships are preserved algebraically.
-"""
-from ucon.dimension import Dimension
-
-
-class Unit:
-    """
-    Represents a **unit of measure** associated with a :class:`Dimension`.
-
-    Parameters
-    ----------
-    *aliases : str
-        Optional shorthand symbols (e.g., "m", "sec").
-    name : str
-        Canonical name of the unit (e.g., "meter").
-    dimension : Dimension
-        The physical dimension this unit represents.
-
-    Notes
-    -----
-    Units participate in algebraic operations that produce new compound units:
-
-        >>> density = units.gram / units.liter
-        >>> density.dimension
-        <Dimension.density: Vector(T=0, L=-3, M=1, I=0, Θ=0, J=0, N=0)>
-
-    The combination rules follow the same algebra as :class:`Dimension`.
-    """
-    def __init__(self, *aliases: str, name: str = '', dimension: Dimension = Dimension.none):
-        self.dimension = dimension
-        self.name = name
-        self.aliases = aliases
-        self.shorthand = aliases[0] if aliases else self.name
-
-    def __repr__(self):
-        addendum = f' | {self.name}' if self.name else ''
-        return f'<{self.dimension.name}{addendum}>'
-
-    # TODO -- limit `operator` param choices
-    def generate_name(self, unit: 'Unit', operator: str):
-        if (self.dimension is Dimension.none) and not (unit.dimension is Dimension.none):
-            return unit.name
-        if not (self.dimension is Dimension.none) and (unit.dimension is Dimension.none):
-            return self.name
-
-        if not self.shorthand and not unit.shorthand:
-            name = ''
-        elif self.shorthand and not unit.shorthand:
-            name = f'({self.shorthand}{operator}?)'
-        elif not self.shorthand and unit.shorthand:
-            name = f'(?{operator}{unit.shorthand})'
-        else:
-            name = f'({self.shorthand}{operator}{unit.shorthand})'
-        return name
-
-    def __truediv__(self, unit: 'Unit') -> 'Unit':
-        # TODO -- define __eq__ for simplification, here
-        if (self.name == unit.name) and (self.dimension == unit.dimension):
-            return Unit()
-
-        if (unit.dimension is Dimension.none):
-            return self
-        
-        return Unit(name=self.generate_name(unit, '/'), dimension=self.dimension / unit.dimension)
-
-    def __mul__(self, unit: 'Unit') -> 'Unit':
-        return Unit(name=self.generate_name(unit, '*'), dimension=self.dimension * unit.dimension)
-
-    def __eq__(self, unit: 'Unit') -> bool:
-        if not isinstance(unit, Unit):
-            raise TypeError(f'Cannot compare Unit to non-Unit type: {type(unit)}')
-        return (self.name == unit.name) and (self.dimension == unit.dimension)
-
-    def __hash__(self) -> int:
-        return hash(tuple([self.name, self.dimension,]))

ucon-0.3.3rc1.dist-info/RECORD

@@ -1,15 +0,0 @@
-tests/ucon/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/ucon/test_core.py,sha256=a48nfTqg-WJ_jzjVT6KtsBb6E8oPUZaqCmscKDzlG_g,22871
-tests/ucon/test_dimension.py,sha256=JyA9ySFvohs2l6oK77ehCQ7QvvFVqB_9t0iC7CUErjw,7296
-tests/ucon/test_unit.py,sha256=vEPOeSxFBqcRBAUczCN9KPo_dTmLk4LQExPSt6UGVa4,5712
-tests/ucon/test_units.py,sha256=248JZbo8RVvG_q3T0IhKG43vxM4F_2Xgf4_RjGZNsFM,704
-ucon/__init__.py,sha256=ZWWLodIiG17OgCfoAm532wpwmJzdRXlUGX3w6OBxFeQ,1743
-ucon/core.py,sha256=QI0aayUm0rgggdD7_zvdrmV26dbEARCJ6Yj5gn5PitI,13729
-ucon/dimension.py,sha256=uUP05bPE8r15oFeD36DrclNIfBsugV7uFhvtJRYy4qI,6598
-ucon/unit.py,sha256=KxOBcQNxciljGskhZCfktLhRF5u-rWgrTg565Flo3eI,3213
-ucon/units.py,sha256=e1j7skYMghlMZi7l94EAgxq4_lNRDC7FcSooJoE_U50,3689
-ucon-0.3.3rc1.dist-info/licenses/LICENSE,sha256=-Djjiq2wM8Cc6fzTsdMbr_T2_uaX6Yorxcemr3GGkqc,1072
-ucon-0.3.3rc1.dist-info/METADATA,sha256=j9qlRr2LbkyV4WbRFcMjfMSI_hOEujAHb5iBGHO-g0Y,10606
-ucon-0.3.3rc1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ucon-0.3.3rc1.dist-info/top_level.txt,sha256=zZYRJiQrVUtN32ziJD2YEq7ClSvDmVYHYy5ArRAZGxI,11
-ucon-0.3.3rc1.dist-info/RECORD,,