Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
LumiX Documentation
Logo
LumiX Documentation

Getting Started

  • Installation
  • Quick Start Guide
  • Available Solvers

Tutorials

  • Tutorials
    • High School Course Timetabling Tutorial
      • Step 1: Basic Course Timetabling
      • Step 2: Database Integration
      • Step 3: Goal Programming with Teacher Preferences
      • Step 4: Large-Scale Optimization with Room Types
    • Manufacturing Production Planning Tutorial
      • Step 1: Basic Production Planning
      • Step 2: Database Integration
      • Step 3: Goal Programming
      • Step 4: Large-Scale Multi-Period
      • Step 5: Scenario Analysis
      • Step 6: Sensitivity Analysis
      • Step 7: What-If Analysis

User Guide

  • User Guide
    • Core Concepts
      • Variables Guide
      • Constraints Guide
      • Expressions Guide
      • Models Guide
    • Using Solvers
      • Using the Optimizer
      • Choosing a Solver
      • Solver Configuration
      • Solver Capabilities
      • Advanced Solver Features
    • Indexing Guide
      • Single-Model Indexing
      • Multi-Model Indexing
      • Index Dimensions
      • Filtering Strategies
    • Nonlinear Terms
      • Absolute Value Terms
      • Min/Max Operations
      • Bilinear Products
      • Indicator Constraints
      • Piecewise-Linear Functions
    • Linearization Concepts
      • Configuration
      • Linearization Engine
      • Bilinear Product Linearization
      • Piecewise-Linear Approximation
      • Pre-built Nonlinear Functions
    • Utils Module Guide
      • Model Logging Guide
      • ORM Integration Guide
      • Rational Conversion Guide
      • Model Copying and ORM Detachment
    • Solution Handling
      • Accessing Solutions
      • Sensitivity Analysis
      • Goal Programming Solutions
      • Solution Mapping
    • Analysis Tools
      • Sensitivity Analysis
      • Scenario Analysis
      • What-If Analysis
    • Goal Programming
      • Weighted Goal Programming
      • Sequential Goal Programming
      • Constraint Relaxation
      • Objective Building

API Reference

  • API Reference
    • Core Module API
      • lumix.core.model.LXModel
      • lumix.core.variables.LXVariable
      • lumix.core.constraints.LXConstraint
      • lumix.core.expressions.LXLinearExpression
      • lumix.core.expressions.LXQuadraticExpression
      • lumix.core.expressions.LXNonLinearExpression
      • lumix.core.expressions.LXQuadraticTerm
      • lumix.core.enums.LXVarType
      • lumix.core.enums.LXConstraintSense
      • lumix.core.enums.LXObjectiveSense
    • Solvers Module API
      • lumix.solvers.base.LXOptimizer
      • lumix.solvers.base.LXSolverInterface
      • lumix.solvers.ortools_solver.LXORToolsSolver
      • lumix.solvers.gurobi_solver.LXGurobiSolver
      • lumix.solvers.cplex_solver.LXCPLEXSolver
      • lumix.solvers.glpk_solver.LXGLPKSolver
      • lumix.solvers.cpsat_solver.LXCPSATSolver
      • lumix.solvers.capabilities.LXSolverCapability
      • lumix.solvers.capabilities.LXSolverFeature
      • lumix.solvers.capabilities.ORTOOLS_CAPABILITIES
      • lumix.solvers.capabilities.GUROBI_CAPABILITIES
      • lumix.solvers.capabilities.CPLEX_CAPABILITIES
      • lumix.solvers.capabilities.GLPK_CAPABILITIES
      • lumix.solvers.capabilities.CPSAT_CAPABILITIES
    • Indexing Module API
      • lumix.indexing.dimensions.LXIndexDimension
      • lumix.indexing.cartesian.LXCartesianProduct
    • Nonlinear Module API
      • lumix.nonlinear.terms.LXAbsoluteTerm
      • lumix.nonlinear.terms.LXMinMaxTerm
      • lumix.nonlinear.terms.LXBilinearTerm
      • lumix.nonlinear.terms.LXIndicatorTerm
      • lumix.nonlinear.terms.LXPiecewiseLinearTerm
    • Linearization Module API
      • lumix.linearization.engine.LXLinearizer
      • lumix.linearization.config.LXLinearizerConfig
      • lumix.linearization.config.LXLinearizationMethod
      • lumix.linearization.functions.LXNonLinearFunctions
      • lumix.linearization.techniques.LXBilinearLinearizer
      • lumix.linearization.techniques.LXPiecewiseLinearizer
    • Utils Module API
      • lumix.utils.logger.LXModelLogger
      • lumix.utils.orm.LXORMModel
      • lumix.utils.orm.LXORMContext
      • lumix.utils.orm.LXTypedQuery
      • lumix.utils.orm.LXNumeric
      • lumix.utils.rational.LXRationalConverter
    • Solution Module API
      • lumix.solution.solution.LXSolution
      • lumix.solution.mapping.LXSolutionMapper
    • Analysis Module API
      • lumix.analysis.scenario.LXScenario
      • lumix.analysis.scenario.LXScenarioAnalyzer
      • lumix.analysis.scenario.LXScenarioModification
      • lumix.analysis.sensitivity.LXSensitivityAnalyzer
      • lumix.analysis.sensitivity.LXVariableSensitivity
      • lumix.analysis.sensitivity.LXConstraintSensitivity
      • lumix.analysis.whatif.LXWhatIfAnalyzer
      • lumix.analysis.whatif.LXWhatIfResult
      • lumix.analysis.whatif.LXWhatIfChange
    • Goal Programming Module API
      • lumix.goal_programming.goal.LXGoal
      • lumix.goal_programming.goal.LXGoalMetadata
      • lumix.goal_programming.goal.LXGoalMode
      • lumix.goal_programming.goal.get_deviation_var_name
      • lumix.goal_programming.goal.priority_to_weight
      • lumix.goal_programming.relaxation.RelaxedConstraint
      • lumix.goal_programming.relaxation.relax_constraint
      • lumix.goal_programming.relaxation.relax_constraints
      • lumix.goal_programming.objective_builder.build_weighted_objective
      • lumix.goal_programming.objective_builder.build_sequential_objectives
      • lumix.goal_programming.objective_builder.combine_objectives
      • lumix.goal_programming.objective_builder.extract_custom_objectives
      • lumix.goal_programming.solver.LXGoalProgrammingSolver
      • lumix.goal_programming.solver.solve_goal_programming

Development

  • Development Guide
    • Core Architecture
    • Extending Core Components
    • Solvers Architecture
    • Extending Solvers
    • Indexing Architecture
    • Extending Indexing
    • Nonlinear Module Architecture
    • Extending Nonlinear Module
    • Linearization Architecture
    • Extending Linearization
    • Utils Module Architecture
    • Extending Utils Components
    • Solution Module Architecture
    • Extending Solution Components
    • Analysis Architecture
    • Extending Analysis
    • Goal Programming Architecture
    • Extending Goal Programming
    • Design Decisions

Examples

  • Examples
    • Basic Linear Programming Example
    • Production Planning Example
    • Driver Scheduling Example
    • Facility Location Example
    • CP-SAT Assignment Example
    • McCormick Envelope Linearization Example
    • Piecewise-Linear Approximation Example
    • Scenario Analysis Example
    • Sensitivity Analysis Example
    • What-If Analysis Example
    • Goal Programming Example
Back to top

Python Module Index

l
 
l
- lumix
    lumix.utils.logger
    lumix.utils.orm
    lumix.utils.rational
Copyright © 2024, LumiX Contributors
Made with Sphinx and @pradyunsg's Furo