Private API

This page lists non-exported (internal) symbols of CTSolvers.Solvers.


From CTSolvers.Solvers

IpoptTag

CTSolvers.Solvers.IpoptTagType
struct IpoptTag <: CTSolvers.Core.AbstractTag

Tag type for Ipopt-specific implementation dispatch.

KnitroTag

CTSolvers.Solvers.KnitroTagType
struct KnitroTag <: CTSolvers.Core.AbstractTag

Tag type for Knitro-specific implementation dispatch.

MadNCLTag

CTSolvers.Solvers.MadNCLTagType
struct MadNCLTag <: CTSolvers.Core.AbstractTag

Tag type for MadNCL-specific implementation dispatch.

MadNLPTag

CTSolvers.Solvers.MadNLPTagType
struct MadNLPTag <: CTSolvers.Core.AbstractTag

Tag type for MadNLP-specific implementation dispatch.

UnoTag

CTSolvers.Solvers.UnoTagType
struct UnoTag <: CTSolvers.Core.AbstractTag

Tag type for Uno-specific implementation dispatch.

__display

__madnlp_suite_consistent_linear_solver

CTSolvers.Solvers.__madnlp_suite_consistent_linear_solverFunction
__madnlp_suite_consistent_linear_solver(
    _::Type{<:CTSolvers.Strategies.AbstractStrategyParameter},
    linear_solver::Type
) -> Bool

Check if linear solver is consistent with parameter type.

Arguments

  • parameter_type::Type{<:AbstractStrategyParameter}: CPU or GPU parameter
  • linear_solver::Type: Linear solver type

Returns

  • Bool: true if consistent, false otherwise

Notes

  • Default implementation returns true (all combinations allowed)
  • Specific implementations in extensions provide actual consistency checks

__madnlp_suite_default_linear_solver

CTSolvers.Solvers.__madnlp_suite_default_linear_solverFunction
__madnlp_suite_default_linear_solver(
    _::Type{<:CTSolvers.Strategies.GPU}
)

Return the default linear solver for the given parameter type.

Arguments

  • parameter_type::Type{<:AbstractStrategyParameter}: CPU or GPU parameter

Returns

  • Type{<:MadNLP.AbstractLinearSolver}: Default linear solver type

Throws

  • Exceptions.ExtensionError: If GPU parameter used but MadNLPGPU not loaded

Notes

  • Default implementation throws ExtensionError for GPU
  • CPU implementation provided by CTSolversMadNLP extension
  • GPU implementation provided by CTSolversMadNLPGPU extension

build_ipopt_solver

CTSolvers.Solvers.build_ipopt_solverFunction
build_ipopt_solver(
    ::Type{<:CTSolvers.Core.AbstractTag},
    parameter::Type{<:CTSolvers.Strategies.AbstractStrategyParameter};
    kwargs...
)

Stub function that throws ExtensionError if CTSolversIpopt extension is not loaded. Real implementation provided by the extension.

Throws

  • CTBase.Exceptions.ExtensionError: Always thrown by this stub implementation

See also: Ipopt, Strategies.metadata

build_knitro_solver

CTSolvers.Solvers.build_knitro_solverFunction
build_knitro_solver(
    ::Type{<:CTSolvers.Core.AbstractTag},
    parameter::Type{<:CTSolvers.Strategies.AbstractStrategyParameter};
    kwargs...
)

Stub function that throws ExtensionError if CTSolversKnitro extension is not loaded. Real implementation provided by the extension.

Throws

  • CTBase.Exceptions.ExtensionError: Always thrown by this stub implementation

See also: Knitro, Strategies.metadata

build_madncl_solver

CTSolvers.Solvers.build_madncl_solverFunction
build_madncl_solver(
    ::Type{<:CTSolvers.Core.AbstractTag},
    parameter::Type{<:CTSolvers.Strategies.AbstractStrategyParameter};
    kwargs...
)

Stub function that throws ExtensionError if CTSolversMadNCL extension is not loaded. Real implementation provided by the extension.

Throws

  • CTBase.Exceptions.ExtensionError: Always thrown by this stub implementation

See also: MadNCL, Strategies.metadata

build_madnlp_solver

CTSolvers.Solvers.build_madnlp_solverFunction
build_madnlp_solver(
    ::Type{<:CTSolvers.Core.AbstractTag},
    parameter::Type{<:CTSolvers.Strategies.AbstractStrategyParameter};
    kwargs...
)

Stub function that throws ExtensionError if CTSolversMadNLP extension is not loaded. Real implementation provided by the extension.

Throws

  • CTBase.Exceptions.ExtensionError: Always thrown by this stub implementation

See also: MadNLP, Strategies.metadata

build_uno_solver

CTSolvers.Solvers.build_uno_solverFunction
build_uno_solver(
    ::Type{<:CTSolvers.Core.AbstractTag},
    parameter::Type{<:CTSolvers.Strategies.AbstractStrategyParameter};
    kwargs...
)

Stub function that throws ExtensionError if CTSolversUno extension is not loaded. Real implementation provided by the extension.

Throws

  • CTBase.Exceptions.ExtensionError: Always thrown by this stub implementation

See also: Uno, Strategies.metadata