api.md

API Documentation

Docstrings for SeparableOptimization.jl interface members can be accessed through Julia's built-in documentation system or in the list below.

CurrentModule = SeparableOptimization

Contents

Pages = ["api.md"]
Depth = 3

Index

Pages = ["api.md"]

Types

AdmmParams
Settings
Stats
Vars

Functions

Utility

get_num_vars
get_num_constrs
assert_valid

Optimization

optimize

Internals

ADMM

SeparableOptimization.factorize_kkt
SeparableOptimization.solve_kkt!
SeparableOptimization.admm_step!
SeparableOptimization.compute_stats

Prox cache

SeparableOptimization.ProxCache
SeparableOptimization.prox_step

Convergence

SeparableOptimization.get_term_cond_cache
SeparableOptimization.check_term_conds!
SeparableOptimization.ConvergeTermCache
SeparableOptimization.FirstVarsTermCache
SeparableOptimization.get_obj_and_res_from_first_vars