Utils

Logger

class ipctk.LoggerLevel

Bases: pybind11_object

Enumeration of log levels

Members:

trace : Trace level

debug : Debug level

info : Info level

warn : Warning level

error : Error level

critical : Critical level

off : Off level

__annotations__ = {}
__eq__(self, other: object) bool
__getstate__(self) int
__hash__(self) int
__index__(self) int
__init__(self, value: int)
__int__(self) int
__members__ = {'critical': <LoggerLevel.critical: 5>, 'debug': <LoggerLevel.debug: 1>, 'error': <LoggerLevel.error: 4>, 'info': <LoggerLevel.info: 2>, 'off': <LoggerLevel.off: 6>, 'trace': <LoggerLevel.trace: 0>, 'warn': <LoggerLevel.warn: 3>}
__module__ = 'ipctk'
__ne__(self, other: object) bool
__repr__(self) str
__setstate__(self, state: int) None
__str__(self) str
critical = <LoggerLevel.critical: 5>
debug = <LoggerLevel.debug: 1>
error = <LoggerLevel.error: 4>
info = <LoggerLevel.info: 2>
property name : str
off = <LoggerLevel.off: 6>
trace = <LoggerLevel.trace: 0>
property value : int
warn = <LoggerLevel.warn: 3>
ipctk.set_logger_level(level: ipctk.LoggerLevel) None

Set log level

Multi-Threading

ipctk.get_num_threads() int

get maximum number of threads to use

ipctk.set_num_threads(nthreads: int) None

set maximum number of threads to use

Positive Semi-Definite Projection

ipctk.project_to_psd(A: numpy.ndarray[numpy.float64[m, n]], method: ipctk.PSDProjectionMethod = <PSDProjectionMethod.CLAMP: 1>) numpy.ndarray[numpy.float64[m, n]]

Matrix projection onto positive semi-definite cone

Parameters:
A

Symmetric matrix to project

method

PSD projection method

Returns:

Projected matrix

ipctk.project_to_pd(A: numpy.ndarray[numpy.float64[m, n]], eps: float = 1e-08) numpy.ndarray[numpy.float64[m, n]]

Matrix projection onto positive definite cone

Parameters:
A: numpy.ndarray[numpy.float64[m, n]]

Symmetric matrix to project

Returns:

Projected matrix

class ipctk.PSDProjectionMethod

Bases: pybind11_object

Enumeration of implemented PSD projection methods.

Members:

NONE : No PSD projection

CLAMP : Clamp negative eigenvalues to zero

ABS : Flip negative eigenvalues

ABS = <PSDProjectionMethod.ABS: 2>
CLAMP = <PSDProjectionMethod.CLAMP: 1>
NONE = <PSDProjectionMethod.NONE: 0>
__annotations__ = {}
__eq__(self, other: object) bool
__getstate__(self) int
__hash__(self) int
__index__(self) int
__init__(self, value: int)
__int__(self) int
__members__ = {'ABS': <PSDProjectionMethod.ABS: 2>, 'CLAMP': <PSDProjectionMethod.CLAMP: 1>, 'NONE': <PSDProjectionMethod.NONE: 0>}
__module__ = 'ipctk'
__ne__(self, other: object) bool
__repr__(self) str
__setstate__(self, state: int) None
__str__(self) str
property name : str
property value : int

Last update: Dec 03, 2024