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 

6and links are hierarchical in pdoc. 

7 

8Public API: 

9- basanos.math.optimizer 

10 

11Private modules (subject to change): 

12- basanos.math._linalg 

13- basanos.math._signal 

14 

15Usage: 

16 Prefer importing public classes from this package namespace: 

17 

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

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

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

21 True 

22 

23Notes: 

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

25 and may change without notice. 

26""" 

27 

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

29from .optimizer import BasanosConfig as BasanosConfig 

30from .optimizer import BasanosEngine as BasanosEngine