Coverage for src / basanos / math / __init__.py: 100%

1"""Mathematics subpackage for basanos. 

2 

3Provides correlation-aware optimization utilities and related helpers. 

4This package exposes a minimal, stable public API while keeping internal 

5implementation details in private modules so documentation remains clean. 

6 

7Public API: 

8- basanos.math.optimizer 

9 

10Private modules (subject to change): 

11- basanos.math._linalg 

12- basanos.math._signal 

13 

14Usage: 

15 Prefer importing public classes from this package namespace: 

16 

17 >>> from basanos.math import BasanosConfig, BasanosEngine # doctest: +SKIP 

18 >>> from basanos.math import BasanosConfig, BasanosEngine 

19 >>> issubclass(BasanosConfig, object) and issubclass(BasanosEngine, object) 

20 True 

21 

22Notes: 

23 These re-exports are stable; private modules are implementation details 

24 and may change without notice. 

25""" 

26 

27# Public re-exports (explicit aliases so linters recognize intent) 

28from ._engine_solve import MatrixBundle as MatrixBundle 

29from ._engine_solve import SolveStatus as SolveStatus 

30from ._engine_solve import WarmupState as WarmupState 

31from ._factor_model import FactorModel as FactorModel 

32from ._stream import BasanosStream as BasanosStream 

33from ._stream import StepResult as StepResult 

34from .optimizer import BasanosConfig as BasanosConfig 

35from .optimizer import BasanosEngine as BasanosEngine 

36from .optimizer import CovarianceConfig as CovarianceConfig 

37from .optimizer import CovarianceMode as CovarianceMode 

38from .optimizer import EwmaShrinkConfig as EwmaShrinkConfig 

39from .optimizer import SlidingWindowConfig as SlidingWindowConfig 

40 

41__all__ = [ 

42 "BasanosConfig", 

43 "BasanosEngine", 

44 "BasanosStream", 

45 "CovarianceConfig", 

46 "CovarianceMode", 

47 "EwmaShrinkConfig", 

48 "FactorModel", 

49 "MatrixBundle", 

50 "SlidingWindowConfig", 

51 "SolveStatus", 

52 "StepResult", 

53 "WarmupState", 

54]