Logo

Getting Started

  • Installation
    • System Requirements
    • Installing OptiX
    • Solver Installation
      • OR-Tools (Recommended)
      • Gurobi (Commercial)
    • Alternative Installation Methods
      • Using pip (Not Recommended)
      • Development Installation
    • Verification
    • Troubleshooting
      • Common Issues
      • Getting Help
  • Quick Start Guide
    • Your First Optimization Problem
      • Step 1: Import Required Modules
      • Step 2: Create the Problem
      • Step 3: Define Decision Variables
      • Step 4: Add Constraints
      • Step 5: Set Objective Function
      • Step 6: Solve the Problem
      • Complete Example Code
      • Expected Output
    • Understanding the Results
    • Problem Types Overview
      • CSP (Constraint Satisfaction)
      • LP (Linear Programming)
      • GP (Goal Programming)
    • Solver Selection
    • Common Patterns
      • Variable Creation from Data
      • Constraint Patterns
    • Debugging and Validation
      • Problem Validation
      • Solution Analysis
    • Next Steps
    • Common Issues and Solutions
      • Problem: Import Errors
      • Problem: No Solution Found
      • Problem: Unexpected Results
    • Getting Help
  • Examples
    • Example Categories
      • By Problem Type
      • By Application Domain
      • By Complexity Level
    • Complete Example List
      • Classic Diet Problem
        • Problem Background
        • Implementation
        • Advanced Features
        • Running the Complete Example
        • Expected Results
        • Key Learning Points
        • Extensions
        • Implementation Details
      • Bus Assignment Problem (Goal Programming)
        • Problem Background
        • Mathematical Model
        • Implementation
        • Running the Complete Example
        • Expected Results
        • Key Learning Points
        • Extensions and Variations
    • Quick Example Browser
    • Example Features
    • Getting Started
    • Running Examples
    • Common Patterns
      • Variable Creation
      • Constraint Patterns
      • Solution Analysis
    • Best Practices
    • Contributing Examples
    • See Also

User Guide

  • Problem Types
    • Constraint Satisfaction Problems (CSP)
      • When to Use CSP
      • Key Characteristics
    • Linear Programming (LP)
      • When to Use LP
      • Key Characteristics
      • Mathematical Form
    • Goal Programming (GP)
      • When to Use GP
      • Key Characteristics
      • Mathematical Form
    • Problem Type Comparison
    • Advanced Problem Features
      • Special Constraints
      • Database Integration
    • Problem Selection Guide
      • Choosing the Right Problem Type
      • Migration Between Problem Types
    • Best Practices
      • Problem Modeling
      • Performance Tips
      • Common Pitfalls
    • See Also

Tutorials

  • Linear Programming Tutorial
    • What is Linear Programming?
      • Key Components
      • Mathematical Form
    • Tutorial 1: Basic LP Problem
      • Problem Statement
      • Mathematical Formulation
      • Implementation
      • Understanding the Solution
    • Tutorial 2: Multi-Resource Problem
      • Problem Statement
    • Tutorial 3: Advanced LP Concepts
      • Sensitivity Analysis
      • Shadow Prices and Dual Solutions
      • Integer and Binary Variables
    • Tutorial 4: Common LP Patterns
      • Diet/Nutrition Problems
      • Transportation Problems
    • Tutorial 5: Debugging and Validation
      • Common Issues and Solutions
    • Best Practices Summary
    • Next Steps

Examples

  • Classic Diet Problem
    • Problem Background
      • Historical Context
      • Mathematical Formulation
    • Implementation
      • Data Structures
      • Problem Instance Data
      • Nutritional Content Matrix
      • Variable Generation
      • Adding Nutritional Constraints
      • Volume Constraint
      • Setting Objective Function
      • Complete Solution
      • Solution Analysis
    • Advanced Features
      • Solver Configuration
      • Problem Variations
    • Running the Complete Example
    • Expected Results
    • Key Learning Points
    • Extensions
    • Implementation Details
  • Bus Assignment Problem (Goal Programming)
    • Problem Background
      • Historical Context
      • Problem Formulation
    • Mathematical Model
    • Implementation
      • Data Structure Setup
      • Problem Creation
      • Goal Constraints Implementation
      • Operational Constraints
      • Complete Solution
      • Solution Analysis
      • Advanced Analysis Features
    • Running the Complete Example
    • Expected Results
    • Key Learning Points
    • Extensions and Variations

API Reference

  • Problem Module
    • Problem Types
      • OXCSPProblem
        • OXCSPProblem.db
        • OXCSPProblem.variables
        • OXCSPProblem.constraints
        • OXCSPProblem.specials
        • OXCSPProblem.constraints_in_special_constraints
        • OXCSPProblem.db
        • OXCSPProblem.variables
        • OXCSPProblem.constraints
        • OXCSPProblem.specials
        • OXCSPProblem.constraints_in_special_constraints
        • OXCSPProblem.create_special_constraint()
        • OXCSPProblem.create_variables_from_db()
        • OXCSPProblem.create_decision_variable()
        • OXCSPProblem.create_constraint()
        • OXCSPProblem.__init__()
      • OXLPProblem
        • OXLPProblem.objective_function
        • OXLPProblem.objective_type
        • OXLPProblem.db
        • OXLPProblem.variables
        • OXLPProblem.constraints
        • OXLPProblem.specials
        • OXLPProblem.objective_function
        • OXLPProblem.objective_type
        • OXLPProblem.create_objective_function()
        • OXLPProblem.__init__()
      • OXGPProblem
        • OXGPProblem.goal_constraints
        • OXGPProblem.objective_function
        • OXGPProblem.objective_type
        • OXGPProblem.db
        • OXGPProblem.variables
        • OXGPProblem.constraints
        • OXGPProblem.specials
        • OXGPProblem.goal_constraints
        • OXGPProblem.create_goal_constraint()
        • OXGPProblem.create_objective_function()
        • OXGPProblem.__init__()
    • Enumerations
      • ObjectiveType
        • ObjectiveType.MINIMIZE
        • ObjectiveType.MAXIMIZE
        • ObjectiveType.MINIMIZE
        • ObjectiveType.MAXIMIZE
      • SpecialConstraintType
        • SpecialConstraintType.MultiplicativeEquality
        • SpecialConstraintType.DivisionEquality
        • SpecialConstraintType.ModulusEquality
        • SpecialConstraintType.SummationEquality
        • SpecialConstraintType.ConditionalConstraint
        • SpecialConstraintType.MultiplicativeEquality
        • SpecialConstraintType.DivisionEquality
        • SpecialConstraintType.ModulusEquality
        • SpecialConstraintType.SummationEquality
        • SpecialConstraintType.ConditionalConstraint
    • Examples
      • Creating a Constraint Satisfaction Problem
      • Creating a Linear Programming Problem
      • Creating a Goal Programming Problem
      • Working with Database Objects
      • Special Constraints
      • Functional Constraint Creation
      • Advanced Goal Programming
      • Complex Special Constraints
      • Working with Variable Templates
    • See Also
  • Constraints Module
    • Constraint Classes
      • Linear Constraints
        • OXConstraint
        • OXGoalConstraint
      • Constraint Collections
        • OXConstraintSet
      • Mathematical Expressions
        • OXpression
        • get_integer_numerator_and_denominators()
      • Special Constraints
        • OXSpecialConstraint
        • OXNonLinearEqualityConstraint
        • OXMultiplicativeEqualityConstraint
        • OXDivisionEqualityConstraint
        • OXModuloEqualityConstraint
        • OXSummationEqualityConstraint
        • OXConditionalConstraint
    • Enumerations
      • RelationalOperators
        • RelationalOperators.GREATER_THAN
        • RelationalOperators.GREATER_THAN_EQUAL
        • RelationalOperators.EQUAL
        • RelationalOperators.LESS_THAN
        • RelationalOperators.LESS_THAN_EQUAL
        • RelationalOperators.GREATER_THAN
        • RelationalOperators.GREATER_THAN_EQUAL
        • RelationalOperators.EQUAL
        • RelationalOperators.LESS_THAN
        • RelationalOperators.LESS_THAN_EQUAL
    • Examples
      • Basic Linear Constraints
      • Goal Programming Constraints
      • Constraint Sets
      • Mathematical Expressions
      • Special Constraints
      • Conditional Constraints
      • Constraint Validation
      • Precise Arithmetic with Fractions
    • See Also
  • Variables Module
    • Core Variable Classes
      • Base Decision Variable
        • OXVariable
      • Goal Programming Variables
        • OXDeviationVar
      • Goal Programming Examples
      • Variable Collections
        • OXVariableSet
    • Variable Architecture
    • Examples
      • Creating Variables
      • Variable Sets and Collections
      • Advanced Variable Management
      • Working with Variable Values
      • Variable Search and Filtering
      • Dynamic Variable Creation
      • Variable Validation and Analysis
      • Variable Transformation and Scaling
      • Performance Optimization
      • Variable Export and Import
    • See Also
  • Solvers Module
    • Solver Factory
      • solve()
    • Solver Interfaces
      • Base Interface
        • OXSolverInterface
      • OR-Tools Solver
        • OR-Tools Solver Integration Module
        • OXORToolsSolverInterface
        • OXORToolsSolverInterface
      • Gurobi Solver
        • Gurobi Solver Integration Module
        • OXGurobiSolverInterface
        • OXGurobiSolverInterface
    • Solution Management
    • Examples
      • Basic Solving
      • Solver Comparison
      • Custom Solver Implementation
      • Advanced Solver Configuration
      • Parallel Solving
      • Solution Analysis
      • Multi-Scenario Solving
      • Advanced Multi-Scenario Analysis
      • Constraint-Based Scenarios
      • Mixed Data and Constraint Scenarios
    • See Also
  • Data Module
    • Data Classes
      • Data Objects
        • OXData
      • Database Collections
        • OXDatabase
    • Constants
      • NON_SCENARIO_FIELDS
    • Examples
      • Basic Data Objects with Scenarios
      • Database Collections
      • Scenario Management for Optimization
      • Scenario-Based Sensitivity Analysis
      • Working with Multiple Data Types
      • UUID-Based Object Access
      • Advanced Scenario Patterns
      • Type Safety and Error Handling
    • See Also
  • Analysis Module
    • Analysis Classes
      • Objective Function Analysis
        • OXObjectiveFunctionAnalysis
        • OXObjectiveFunctionAnalysisResult
      • Right-Hand Side Analysis
        • OXRightHandSideAnalysis
        • OXRightHandSideAnalysisResult
        • OXConstraintRHSAnalysis
    • Examples
      • Basic Analysis Workflow
      • Objective Function Analysis
      • Right-Hand Side Analysis
      • Scenario Comparison
      • Multi-Solver Analysis
      • Performance Analysis
      • Integration with Problem Types
    • See Also
  • Utilities Module
    • Module Functions
      • Class Loading Functions
        • get_fully_qualified_name()
        • load_class()
    • Examples
      • Basic Class Loading
      • Integration with Serialization
      • Error Handling
    • See Also

About

  • Changelog
    • [Unreleased]
      • Added
      • Enhanced
      • Fixed
    • [1.0.0] - 2024-12-15
      • Added
      • Changed
    • [0.1.0] - 2024-06-01
      • Added
      • Requirements
    • Migration Guide
      • Upgrading from 0.1.0 to 1.0.0
    • Deprecation Notices
    • Breaking Changes
    • Security Updates
    • Performance Improvements
    • Bug Fixes
    • Known Issues
    • Contributing
      • Reporting Issues
    • Release Process
      • Release Schedule
    • Acknowledgments
    • License Information
    • Support and Resources
    • Version Comparison
    • Download Information
    • Statistics
  • License
    • Academic Free License v. 3.0
    • License Summary
    • Key Differences from Other Licenses
    • Copyright Notice
    • Third-Party Licenses
    • License Compatibility
    • For Academic Use
    • For Commercial Use
    • License Enforcement
    • Getting Legal Help
    • Contact Information
OptiX
  • Overview: module code

All modules for which code is available

  • analysis.OXObjectiveFunctionAnalysis
  • analysis.OXRightHandSideAnalysis
  • constraints.OXConstraint
  • constraints.OXConstraintSet
  • constraints.OXSpecialConstraints
  • constraints.OXpression
  • data.OXData
  • data.OXDatabase
  • problem.OXProblem
  • solvers.OXSolverFactory
  • solvers.OXSolverInterface
  • solvers.gurobi.OXGurobiSolverInterface
  • solvers.ortools.OXORToolsSolverInterface
  • utilities.class_loaders
  • variables.OXDeviationVar
  • variables.OXVariable
  • variables.OXVariableSet

© Copyright 2025, Tolga BERBER, Beyzanur SİYAH. Last updated on Aug 04, 2025.

Built with Sphinx using a theme provided by Read the Docs.