Skip to content

[Dev] Naming convention for types #699

@ocots

Description

@ocots

Review the naming convention of types:

# CTBase.Exceptions
CTException
IncorrectArgument
PreconditionError
NotImplemented
ParsingError
AmbiguousDescription
ExtensionError

# CTDirect
AbstractOptimalControlDiscretizer
Collocation

# CTModels
AbstractOptimalControlInitialGuess
OptimalControlInitialGuess
AbstractModel
AbstractOptimalControlProblem # alias
Model
AbstractSolution
AbstractOptimalControlSolution # alias
Solution

# CTSolvers
DiscretizedOptimalControlProblem
AbstractOptimizationModeler
ADNLPModeler
ExaModeler
AbstractOptimizationSolver
IpoptSolver
MadNLPSolver
MadNCLSolver
KnitroSolver
AbstractStrategy
StrategyRegistry
StrategyMetadata
StrategyOptions
OptionDefinition
RoutedOption

Rule: no duplication of the module / package name.

Metadata

Metadata

Labels

internal devModification to the code is requested and should not affect user experiment

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions