SequentialJobGraph.h

Go to the documentation of this file.

// ========================================================================= //
// This file is part of MyraMath, copyright (c) 2014-2019 by Ryan A Chilton  //
// and distributed by MyraCore, LLC. See LICENSE.txt for license terms.      //
// ========================================================================= //

#ifndef MYRAMATH_JOBGRAPH_SEQUENTIALJOBGRAPH_H
#define MYRAMATH_JOBGRAPH_SEQUENTIALJOBGRAPH_H

#include <myramath/MYRAMATH_EXPORT.h>

#include <myramath/jobgraph/Job.h>
#include <myramath/jobgraph/JobID.h>
#include <myramath/jobgraph/JobGraph.h>
#include <myramath/jobgraph/Options.h>

#include <set>
#include <string>
#include <stdint.h>

namespace myra {

class SequentialJobGraph;

class MYRAMATH_EXPORT SequentialJobGraph : public JobGraphBase
  {
  public:

    // --------------------------- Container API.

    SequentialJobGraph();

    int push_back(const JobGraph& g);

    const JobGraph& at(int g) const;

    // --------------------------- Base JobGraph overrides.

    virtual uint64_t n_work() const;
    
    virtual std::string name() const;

    virtual void begins(JobIDs& output) const;

    virtual void ends(JobIDs& output) const;

    virtual ::myra::Job* create(JobID j);

    virtual std::vector<Job*> create();

    uint64_t size() const;

    virtual ::myra::JobGraphBase* clone() const;

    virtual ~SequentialJobGraph();
  
  private:

    // Internal contents.
    typedef std::vector<JobGraph> Subgraphs;
    Subgraphs subgraphs;

    // JobID offsets for each SentinelJob.
    std::vector<uint64_t> sentinels;

    // Implementation detail, a Job that sits between the ends() of one subgraph[] and the begins() of the next.
    class SentinelJob : public ::myra::Job
      {
      private:

        // Which subgraph does this SentinelJob precede.
        int g;

        // Host graph.
        SequentialJobGraph* host;

      public:

        // Constructor, requires g and host.
        SentinelJob(int in_g, SequentialJobGraph* in_host);

        // Delegates to job->id(), adds offset.
        virtual JobID id() const override;

        // Delegates to job->parents(), adds offsets to each. Appends any inter-subgraph parents.
        virtual void parents(JobIDs& output) const;

        // Delegates to job->children(), adds offsets to each. Appends any inter-subgraph children.
        virtual void children(JobIDs& output) const;

        // Returns job->execute()
        virtual uint64_t execute();

        // Returns job->name()
        virtual std::string name() const;

        // Deletes job.
        virtual ~SentinelJob();

      };

    // Implementation detail, a Job that delegates everything to an underlying Job from one of the contained subgraphs[]
    class SequentialJob : public ::myra::Job
      {
      private:
      
        // Underlying Job.
        ::myra::Job* job;

        // Which subgraph it came from.
        int g;

        // Host graph.
        SequentialJobGraph* host;
        
      public:

        // Constructor, requires underlying Job* and host SequentialJobGraph*.
        SequentialJob(::myra::Job* in_job, int in_g, SequentialJobGraph* in_host);

        // Delegates to job->id(), adds offset.
        virtual JobID id() const override;

        // Delegates to job->parents(), adds offsets to each. Appends any inter-subgraph parents.
        virtual void parents(JobIDs& output) const;

        // Delegates to job->children(), adds offsets to each. Appends any inter-subgraph children.
        virtual void children(JobIDs& output) const;

        // Returns job->execute()
        virtual uint64_t execute();

        // Returns job->name()
        virtual std::string name() const;

        // Deletes job.
        virtual ~SequentialJob();

      };

    // These implementation details are friends.
    friend class SequentialJob;
    friend class SentinelJob;

  };

MYRAMATH_EXPORT JobGraph sequentialize(const JobGraph& g0, const JobGraph& g1);
MYRAMATH_EXPORT JobGraph sequentialize(const JobGraph& g0, const JobGraph& g1, const JobGraph& g2);
MYRAMATH_EXPORT JobGraph sequentialize(const JobGraph& g0, const JobGraph& g1, const JobGraph& g2, const JobGraph& g3);
MYRAMATH_EXPORT JobGraph sequentialize(const JobGraph& g0, const JobGraph& g1, const JobGraph& g2, const JobGraph& g3, const JobGraph& g4);

} // namespace myra

#endif