DispersionEngine.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX INC 2025. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX INC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX INC.
******************************************************************************/
/*
Normal Random Distribution Header File
 
Author: Alex Reynolds
*/
#ifndef DISPERSION_ENGINE_H
#define DISPERSION_ENGINE_H
 
#include <vector>
 
#include "UniformRandom.hpp"
#include "NormalRandom.hpp"
#include "flight/FlightExecutive.h"
 
namespace warptwin {

    struct Dispersion {
        Dispersion(std::string nme, double d_v, clockwerk::GraphTreeObject* parent)
            : default_val(d_v), value(parent, nme.c_str(), 0.0) {}
        double default_val;
        clockwerk::DataIO<double> value;
        clockwerk::DataIO<double>& operator () () {return value;}
    };

    struct UniformDispersion : public Dispersion {
        UniformDispersion(std::string nme, double d_v, double mn, double mx, clockwerk::GraphTreeObject* parent)
        : Dispersion(nme, d_v, parent), min(mn), max(mx) {}
        double min;
        double max;
    };

    struct NormalDispersion : public Dispersion {
        NormalDispersion(std::string nme, double d_v, double mn, double sd, clockwerk::GraphTreeObject* parent)
            : Dispersion(nme, d_v, parent), mean(mn), stdev(sd) {}
        double mean;
        double stdev;
    };
 
    const int HASH_MULTIPLIER = 37;
    const int HASH_ADDER = 3;

    class DispersionEngine : public clockwerk::GraphTreeObject {
    public:
        // Standard constructor. Takes executive
        DispersionEngine(warpos::FlightExecutive &e) : exc(e) {}
        ~DispersionEngine();

        void initialize(int seed, int run, int nruns=1000);

        void setUniformValue(UniformDispersion* dispersion_ptr);

        void setNormalValue(NormalDispersion* dispersion_ptr);

        UniformDispersion& createUniformInputDispersion(const std::string &name, 
                                                        double default_val, double min, double max);

        NormalDispersion& createNormalInputDispersion(const std::string &name, 
                                                    double default_val, double mean, double stdev);

        Dispersion* operator () (const std::string &query);
 
        // Pointer to the executive object
        warpos::FlightExecutive& exc;
 
        // The has seed generated by the dispersion engine
        int hash_seed = 0;
    protected:
        int _hash(int run_number, int seed);
 
        // Variable to store our hash value
        int _hash_value;
 
        // Variable to store the current run number
        int _run_number;
 
        // Variable to set the number of runs
        int _nruns;
 
        // Our lists to store each type of dispersion info
        std::vector<UniformDispersion*> _uniform_dispersions;
        std::vector<NormalDispersion*> _normal_dispersions;
 
        // Our distribution engines for generating varied inputs
        UniformRandom<double>* _uniform_dist = nullptr;
        NormalRandom<double>* _normal_dist = nullptr;
    };
 
}
 
#endif