API Reference¶

Complete API documentation for all LumiX modules with auto-generated documentation from source code.

API Modules

Core Module¶

The Core Module API module provides the fundamental building blocks for optimization models:

LXModel - Model builder with fluent API
LXVariable - Type-safe variable families
LXConstraint - Data-driven constraints
LXLinearExpression - Linear expressions
LXQuadraticExpression - Quadratic expressions
LXVarType - Variable type enumeration
LXConstraintSense - Constraint sense enumeration
LXObjectiveSense - Objective sense enumeration

Solvers Module¶

The Solvers Module API module provides a unified interface to multiple optimization solvers:

LXOptimizer - Main optimizer interface
LXSolverInterface - Base solver interface
LXSolverCapability - Solver capability descriptions
LXSolverFeature - Solver feature flags

Supported solvers: OR-Tools, Gurobi, CPLEX, GLPK, CP-SAT

Indexing Module¶

The Indexing Module API module provides multi-dimensional indexing capabilities:

LXIndexDimension - Single dimension with filtering
LXCartesianProduct - Multi-dimensional cartesian products

Nonlinear Module¶

The Nonlinear Module API module provides nonlinear term definitions:

LXAbsoluteTerm - Absolute value operations x
LXMinMaxTerm - Min/max over multiple variables
LXBilinearTerm - Products of two variables x*y
LXIndicatorTerm - Conditional (if-then) constraints
LXPiecewiseLinearTerm - Piecewise-linear function approximations

Linearization Module¶

The Linearization Module API module provides automatic linearization of nonlinear terms:

LXLinearizer - Main linearization engine
LXLinearizerConfig - Configuration settings
LXLinearizationMethod - Available methods
LXNonLinearFunctions - Pre-built function approximations
LXBilinearLinearizer - Bilinear product linearization
LXPiecewiseLinearizer - Piecewise-linear approximation

Utils Module¶

The Utils Module API module provides utility classes for enhanced functionality:

LXModelLogger - Enhanced logging for optimization models
LXORMContext - Type-safe ORM query interface
LXTypedQuery - Fluent query builder with type safety
LXRationalConverter - Float-to-rational conversion

Solution Module¶

The Solution Module API module provides solution handling and mapping utilities:

LXSolution - Solution container with variable values and metadata
LXSolutionMapper - Utilities for mapping solutions to model instances

Analysis Module¶

The Analysis Module API module provides comprehensive post-optimization analysis tools:

LXSensitivityAnalyzer - Sensitivity analysis with shadow prices and reduced costs
LXScenarioAnalyzer - Systematic scenario comparison
LXWhatIfAnalyzer - Interactive what-if exploration
LXVariableSensitivity - Variable sensitivity results
LXConstraintSensitivity - Constraint sensitivity results
LXScenario - Scenario definition
LXWhatIfResult - What-if analysis results

Goal Programming Module¶

The Goal Programming Module API module provides automatic LP-to-Goal Programming conversion:

LXGoal - Goal instance with metadata
LXGoalMetadata - Goal configuration (priority, weight, sense)
LXGoalMode - Solving modes (WEIGHTED, SEQUENTIAL)
RelaxedConstraint - Relaxed constraint with deviations
LXGoalProgrammingSolver - Sequential goal programming solver
relax_constraint() - Constraint relaxation function
build_weighted_objective() - Build weighted objectives
build_sequential_objectives() - Build sequential objectives

Quick Links¶

Most Commonly Used Classes

Core:

lumix.core.model.LXModel - Start here to build models
lumix.core.variables.LXVariable - Define decision variables
lumix.core.constraints.LXConstraint - Add constraints
lumix.core.expressions.LXLinearExpression - Build expressions

Solvers:

lumix.solvers.base.LXOptimizer - Solve models with any solver
lumix.solvers.capabilities.LXSolverCapability - Query solver capabilities

Indexing:

lumix.indexing.dimensions.LXIndexDimension - Single dimension indexing
lumix.indexing.cartesian.LXCartesianProduct - Multi-dimensional products

Nonlinear:

lumix.nonlinear.terms.LXAbsoluteTerm - Absolute value terms
lumix.nonlinear.terms.LXBilinearTerm - Bilinear products
lumix.nonlinear.terms.LXPiecewiseLinearTerm - Piecewise-linear approximations

Linearization:

lumix.linearization.engine.LXLinearizer - Automatic linearization engine
lumix.linearization.config.LXLinearizerConfig - Linearization configuration
lumix.linearization.functions.LXNonLinearFunctions - Pre-built functions

Utils:

lumix.utils.logger.LXModelLogger - Model logging utilities
lumix.utils.orm.LXORMContext - ORM integration
lumix.utils.rational.LXRationalConverter - Rational conversion

Solution:

lumix.solution.solution.LXSolution - Solution container and access
lumix.solution.mapping.LXSolutionMapper - Solution mapping utilities

Analysis:

lumix.analysis.sensitivity.LXSensitivityAnalyzer - Sensitivity analysis
lumix.analysis.scenario.LXScenarioAnalyzer - Scenario comparison
lumix.analysis.whatif.LXWhatIfAnalyzer - What-if exploration

Goal Programming:

lumix.goal_programming.goal.LXGoal - Goal instances
lumix.goal_programming.goal.LXGoalMetadata - Goal metadata
lumix.goal_programming.solver.LXGoalProgrammingSolver - Sequential solver
lumix.goal_programming.relaxation.relax_constraint() - Constraint relaxation

Quick Reference¶

For quick help with any class:

Use IDE Autocomplete: LumiX is fully type-annotated
Check Docstrings: All classes and methods have comprehensive docstrings
Browse Source: The source code is well-documented
See Examples: The examples directory shows practical usage

Example: Getting Help¶

from lumix import LXModel

# In Python, use help() to see docstrings
help(LXModel)

# Or in IPython/Jupyter
LXModel?

# For method signatures
LXModel.add_variable?