Scaling.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <optional>
#include <string>
#include <vector>
 
namespace janus {

enum class ScalingIssueLevel {
    Warning, 
    Critical 
};

enum class ScalingIssueKind {
    Variable,   
    Constraint, 
    Objective,  
    Summary     
};

struct ScalingAnalysisOptions {
    double normalized_low_warn = 1e-3;      
    double normalized_high_warn = 1e3;      
    double normalized_high_critical = 1e6;  
    double variable_scale_ratio_warn = 1e6; 
};

struct ScalingIssue {
    ScalingIssueLevel level = ScalingIssueLevel::Warning;
    ScalingIssueKind kind = ScalingIssueKind::Variable;
    int index = -1;                    
    std::string label;                 
    std::string message;               
    double raw_magnitude = 0.0;        
    double applied_scale = 1.0;        
    double normalized_magnitude = 0.0; 
    double suggested_scale = 1.0;      
};

struct VariableScalingInfo {
    int block_index = -1;
    int size = 0;
    std::string category = "Uncategorized";
    bool frozen = false;
    bool user_supplied_scale = false;
    double scale = 1.0;
    double init_abs_mean = 0.0;
    double init_abs_max = 0.0;
    double normalized_init_abs_mean = 0.0;
    double normalized_init_abs_max = 0.0;
    std::optional<double> lower_bound;
    std::optional<double> upper_bound;
    double suggested_scale = 1.0;
};

struct ConstraintScalingInfo {
    int row = -1;
    bool has_lower_bound = false;
    bool has_upper_bound = false;
    bool equality = false;
    double lower_bound = 0.0;
    double upper_bound = 0.0;
    double value_at_initial = 0.0;
    double scale = 1.0;
    double normalized_magnitude = 0.0;
    double normalized_violation = 0.0;
    double suggested_scale = 1.0;
};

struct ObjectiveScalingInfo {
    bool configured = false;
    bool maximize = false;
    bool user_supplied_scale = false;
    double value_at_initial = 0.0;
    double scale = 1.0;
    double normalized_value = 0.0;
    double suggested_scale = 1.0;
};

struct ScalingSummary {
    int variable_blocks = 0;
    int scalar_constraints = 0;
    int jacobian_nnz = 0;
    double jacobian_density = 0.0;
    double min_variable_scale = 1.0;
    double max_variable_scale = 1.0;
    double variable_scale_ratio = 1.0;
};

struct ScalingReport {
    ScalingSummary summary;                         
    ObjectiveScalingInfo objective;                 
    std::vector<VariableScalingInfo> variables;     
    std::vector<ConstraintScalingInfo> constraints; 
    std::vector<ScalingIssue> issues;               

    bool has_issues() const { return !issues.empty(); }
};
 
} // namespace janus