Internal API

These functions and types are for internal usage and should generally not be accessed during normal use of the package. This will likely be useful if implementing an extension to the package.

Fully documenting every function is currently ongoing. Please raise an issue if information is missing.

Core

Missing docstring.

Missing docstring for DirectSearch.EvaluateInitialPoint. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.EvaluatePoint!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.EvaluatePointSequential!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.EvaluatePointParallel!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.function_evaluation. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.function_evaluation_parallel. Check Documenter's build log for details.

Constraints

Missing docstring.

Missing docstring for DirectSearch.AbstractConstraint. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.IterationOutcome. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.ConstraintOutcome. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.CollectionIndex. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.ConstraintIndex. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.ConstraintCollection. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.h_max_update. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.AbstractProgressiveConstraint. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.ProgressiveConstraint. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.ExtremeConstraint. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.Constraints. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.CollectionTypeCount. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.ConstraintUpdate!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.ConstraintEvaluation. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.GetHmaxSum. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.ConstraintCollectionEvaluation(::DirectSearch.ConstraintCollection{T,DirectSearch.ProgressiveConstraint}, ::Vector{T}) where T. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.ConstraintCollectionEvaluation(::DirectSearch.ConstraintCollection{T,DirectSearch.ExtremeConstraint}, ::Vector{T}) where T. Check Documenter's build log for details.

Mesh

Missing docstring.

Missing docstring for DirectSearch.AbstractMesh. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.MeshSetup!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.MeshUpdate!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.SetMeshParameters!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.SetMeshSizeVector!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.SetPollSizeVector!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.SetRatioVector!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.init_a_and_b!. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.get_poll_size_estimate. Check Documenter's build log for details.

Poll

Missing docstring.

Missing docstring for DirectSearch.Poll. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.GeneratePollPoints. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.GenerateDirections(::DSProblem). Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.SafePointGeneration. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.ScaleDirection. Check Documenter's build log for details.

Search

Missing docstring.

Missing docstring for DirectSearch.Search. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.GenerateSearchPoints(::DSProblem{T}) where T. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.GenerateSearchPoints(::DSProblem{T}, ::RandomSearch) where T. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.GenerateSearchPoints(::DSProblem, ::NullSearch). Check Documenter's build log for details.

LTMADS

Missing docstring.

Missing docstring for DirectSearch.GenerateDirections(::DirectSearch.AbstractProblem, ::LTMADS{T}) where T. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.form_basis_matrix. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.LT_basis_generation. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.B′_generation. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.b_l_generation. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.L_generation. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.B_generation. Check Documenter's build log for details.

OrthoMADS

Missing docstring.

Missing docstring for DirectSearch.GenerateDirections(::DirectSearch.AbstractProblem, ::OrthoMADS). Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.GenerateDirectionsOnUnitSphere. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.HouseholderTransform. Check Documenter's build log for details.

Cache

Missing docstring.

Missing docstring for DirectSearch.AbstractCache. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.PointCache. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.CachePush(::DirectSearch.AbstractProblem{T}, ::Vector{T}, ::T) where T. Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.CachePush(::DirectSearch.AbstractProblem). Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.CacheQuery(::DirectSearch.AbstractProblem, ::Vector). Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.CacheGet(::DirectSearch.AbstractProblem, ::Vector). Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.CacheRandomSample(::DirectSearch.AbstractProblem, ::Int). Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.CacheInitialPoint(::DirectSearch.AbstractProblem). Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.CacheGetRange(::DirectSearch.AbstractProblem, ::Vector). Check Documenter's build log for details.

Missing docstring.

Missing docstring for DirectSearch.CacheFilter(::DirectSearch.AbstractProblem, ::Vector). Check Documenter's build log for details.