Settings
            Settings
¶
    Settings for the library.
Attributes¶
            factory_manager
  
      property
      writable
  
¶
factory_manager: FactoryManager
Get/Set the factory manager.
Getter¶
Returns:
| Type | Description | 
|---|---|
                  FactoryManager
             | 
            
               factory manager  | 
          
Setter¶
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
                value
             | 
            
                  FactoryManager
             | 
            
               factory manager  | 
            required | 
Functions¶
            __init__
¶
__init__(
    float_type: Any = float64,
    decimals: int = 3,
    atol: float = 0.001,
    rtol: float = 0.0,
    alias: str = "fl",
    logger: Logger | None = None,
    factory_manager: FactoryManager | None = None,
) -> None
Constructor.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
                float_type
             | 
            
                  Any
             | 
            
               floating point type.  | 
            
                  float64
             | 
          
                decimals
             | 
            
                  int
             | 
            
               number of decimals.  | 
            
                  3
             | 
          
                atol
             | 
            
                  float
             | 
            
               absolute tolerance.  | 
            
                  0.001
             | 
          
                rtol
             | 
            
                  float
             | 
            
               relative tolerance.  | 
            
                  0.0
             | 
          
                alias
             | 
            
                  str
             | 
            
               alias to use when representing objects (ie,   | 
            
                  'fl'
             | 
          
                logger
             | 
            
                  Logger | None
             | 
            
               logger.  | 
            
                  None
             | 
          
                factory_manager
             | 
            
                  FactoryManager | None
             | 
            
               factory manager.  | 
            
                  None
             | 
          
            __repr__
¶
__repr__() -> str
Return code to construct the settings in Python.
Returns:
| Type | Description | 
|---|---|
                  str
             | 
            
               code to construct the settings in Python  | 
          
            context
¶
context(
    *,
    float_type: Any | None = None,
    decimals: int | None = None,
    atol: float | None = None,
    rtol: float | None = None,
    alias: str | None = None,
    logger: Logger | None = None,
    factory_manager: FactoryManager | None = None
) -> Generator[None, None, None]
Create a context with specific settings.
Parameters:
| Name | Type | Description | Default | 
|---|---|---|---|
                float_type
             | 
            
                  Any | None
             | 
            
               floating point type  | 
            
                  None
             | 
          
                decimals
             | 
            
                  int | None
             | 
            
               number of decimals.  | 
            
                  None
             | 
          
                atol
             | 
            
                  float | None
             | 
            
               absolute tolerance.  | 
            
                  None
             | 
          
                rtol
             | 
            
                  float | None
             | 
            
               relative tolerance.  | 
            
                  None
             | 
          
                alias
             | 
            
                  str | None
             | 
            
               alias for the library.  | 
            
                  None
             | 
          
                logger
             | 
            
                  Logger | None
             | 
            
               logger.  | 
            
                  None
             | 
          
                factory_manager
             | 
            
                  FactoryManager | None
             | 
            
               factory manager.  | 
            
                  None
             | 
          
Returns:
| Type | Description | 
|---|---|
                  None
             | 
            
               context with specific settings.  |