DifferentialCorrectorProfile.hpp

浏览该文件的文档.

 
 
#pragma once
 
#include "AstGlobal.h"
#include "TargeterProfile.hpp"
#include "AstCore/ShooterControl.hpp"
#include "AstCore/ShooterResult.hpp"
#include "AstCore/ScriptingToolProfile.hpp"
#include "AstCore/TargeterGraph.hpp"
 
AST_NAMESPACE_BEGIN
 
enum class EFiniteDifferenceMethod
{
    eForwardDifference,     
    eCentralDifference,     
    eBackwardDifference,    
};
 
enum class ERootFindingAlgorithm
{
    eSecantMethod,     
};
 
enum class EConvergenceCriteria
{
    eEqualityConstraintsWithinTolerance, 
};
 
enum class EScaleControls
{
    eByInitialValue, 
};
 
enum class EScaleGoals
{
    eByDesiredValue, 
};
 
class Sequence;
 
class AST_CORE_API DifferentialCorrectorProfile : public TargeterProfile
{
public:
    AST_OBJECT(DifferentialCorrectorProfile)
    AST_PROPERT(useHomotopy)
    AST_PROPERT(numHomotopySteps)
    AST_PROPERT(useLineSearch)
    AST_PROPERT(lineSearchTolerance)
    AST_PROPERT(lineSearchMaxNumCalls)
    AST_PROPERT(lineSearchLowerBound)
    AST_PROPERT(lineSearchUpperBound)
    AST_PROPERT(maxIterations)
    using ControlVector = std::vector<SharedPtr<ShooterControl>>;
    using ResultVector = std::vector<SharedPtr<ShooterResult>>;
    using TargeterGraphVector = std::vector<SharedPtr<TargeterGraph>>;
 
    static DifferentialCorrectorProfile* New();
 
    DifferentialCorrectorProfile() = default;
    ~DifferentialCorrectorProfile() override = default;
 
    errc_t execute() override;
 
 
protected:
    errc_t executeRelatedCommand() const;
 
    Sequence* getRelatedSequence() const;
 
    Command* getRelatedCommand() const;
PROPERTIES:
    bool useHomotopy() const{return useHomotopy_;}
    void setUseHomotopy(bool useHomotopy){useHomotopy_ = useHomotopy;}
    
    int numHomotopySteps() const{return numHomotopySteps_;}
    void setNumHomotopySteps(int numHomotopySteps){numHomotopySteps_ = numHomotopySteps;}
 
 
    bool useLineSearch() const{return useLineSearch_;}
    void setUseLineSearch(bool useLineSearch){useLineSearch_ = useLineSearch;}
 
    double lineSearchTolerance() const{return lineSearchTolerance_;}
    void setLineSearchTolerance(double tolerance){lineSearchTolerance_ = tolerance;}
 
    int lineSearchMaxNumCalls() const{return lineSearchMaxNumCalls_;}
    void setLineSearchMaxNumCalls(int maxNumCalls){lineSearchMaxNumCalls_ = maxNumCalls;}
 
    double lineSearchLowerBound() const{return lineSearchLowerBound_;}
    void setLineSearchLowerBound(double lowerBound){lineSearchLowerBound_ = lowerBound;}
 
    double lineSearchUpperBound() const{return lineSearchUpperBound_;}
    void setLineSearchUpperBound(double upperBound){lineSearchUpperBound_ = upperBound;}
    
    int maxIterations() const{return maxIterations_;}
    void setMaxIterations(int maxIterations){maxIterations_ = maxIterations;}
public:
    ERootFindingAlgorithm rootFindingAlgorithm() const{return rootFindingAlgorithm_;}
    void setRootFindingAlgorithm(ERootFindingAlgorithm algorithm){rootFindingAlgorithm_ = algorithm;}
 
    EFiniteDifferenceMethod finiteDifferenceMethod() const{return finiteDifferenceMethod_;}
    void setFiniteDifferenceMethod(EFiniteDifferenceMethod method){finiteDifferenceMethod_ = method;}
 
    EConvergenceCriteria convergenceCriteria() const{return convergenceCriteria_;}
    void setConvergenceCriteria(EConvergenceCriteria criteria){convergenceCriteria_ = criteria;}
 
    EScaleControls scaleControls() const{return scaleControls_;}
    void setScaleControls(EScaleControls controls){scaleControls_ = controls;}
 
    EScaleGoals scaleGoals() const{return scaleGoals_;}
    void setScaleGoals(EScaleGoals goals){scaleGoals_ = goals;}
    
    const ControlVector& controls() const{return controls_;}
    void setControls(const ControlVector& controls){controls_ = controls;}
 
    const ResultVector& results() const{return results_;}
    void setResults(const ResultVector& results){results_ = results;}
 
    ShooterResult* getResult(StringView name) const;
    ShooterControl* getControl(StringView name) const;
private:
    mutable WeakPtr<Command> relatedCommand_;
 
    EConvergenceCriteria convergenceCriteria_{EConvergenceCriteria::eEqualityConstraintsWithinTolerance};
    EFiniteDifferenceMethod finiteDifferenceMethod_{EFiniteDifferenceMethod::eForwardDifference};
    double lineSearchLowerBound_ = 1e-6;
    double lineSearchUpperBound_ = 10.0;
    double lineSearchTolerance_ = 1e-6;
    int lineSearchMaxNumCalls_ = 10;
    int maximumRunsToLog_ = 25;
    int maxIterations_ = 50;
    int numHomotopySteps_ = 1;
    ERootFindingAlgorithm rootFindingAlgorithm_{ERootFindingAlgorithm::eSecantMethod};
    EScaleControls scaleControls_{EScaleControls::eByInitialValue};
    EScaleGoals scaleGoals_{EScaleGoals::eByDesiredValue};
    bool useHomotopy_ = false;
    bool useLineSearch_ = false;
 
    ControlVector controls_;
    ResultVector results_;
    TargeterGraphVector graphs_;
    SharedPtr<ScriptingToolProfile> scriptingTool_;
};
 
AST_NAMESPACE_END