Installation

• Dependencies:
• cmake v2.7+
• g++/gcc v4.8.4+ (C++11)
• pthreads
• (Optional) doxygen

• CMake Options:
• CMAKE_INSTALL_PREFIX - Where to install HTGS (and documentation)
• BUILD_DOXYGEN - Creates doxygen documentation (view online at: Documentation)
• RUN_GTEST - Compiles and runs google unit tests for HTGS ('make run-test' to re-run)

 :$ git clone https://github.com/usnistgov/HTGS.git
 :$ cd <HTGS_Directory>
 :<HTGS_Directory>$ mkdir build && cd build
 :<HTGS_Directory>/build$ ccmake ../         (or cmake-gui)

 'Configure' and setup cmake parameters
 'Configure' and 'Build'

 :<HTGS_Directory>/build$ make
 :<HTGS_Directory>/build$ make install
                     

Using HTGS

• HTGS API:
• htgs::IData
• htgs::ITask
• htgs::TaskGraph
• htgs::Runtime

Brief example of adding two numbers using HTGS; filename: "main.cpp". (As seen in Tutorial 1):

  #include <htgs/api/IData.hpp>
  #include <htgs/api/ITask.hpp>
  #include <htgs/api/TaskGraphConf.hpp>
  #include <htgs/api/TaskGraphRuntime.hpp>

  class InputData : public htgs::IData
  {
    public:
      InputData(int x, int y) : x(x), y(y) {}
      int getX() const { return x; }
      int getY() const { return y; }
    private:
      int x, y;
  };

  class OutputData : public htgs::IData
  {
    public:
      OutputData(int result) : result(result) {}
      int getResult() const { return result; }
    private:
      int result;
  };

  class AddTask : public htgs::ITask<InputData, OutputData>
  {
    public:
      virtual AddTask *copy() { return new AddTask(); }
      virtual void executeTask(std::shared_ptr<InputData> data) {
        int sum = data->getX() + data->getY();
        this->addResult(new OutputData(sum));
      }
  };

  int main() {
    AddTask *addTask = new AddTask();
    auto taskGraph = new htgs::TaskGraphConf<InputData, OutputData>();
    taskGraph->setGraphConsumerTask(addTask);
    taskGraph->addGraphProducerTask(addTask);

    auto runtime = new htgs::TaskGraphRuntime(taskGraph);
    runtime->executeRuntime();

    int numData = 10;
    for (int i = 0; i < numData; i++) {
      auto inputData = new InputData(i, i);
      taskGraph->produceData(inputData);
    }

    taskGraph->finishedProducingData();

    runtime->waitForRuntime();

    while(!taskGraph->isOutputTerminated()) {
      auto data = taskGraph->consumeData();
      std::cout << "Result: " << data->getResult() << std::endl;
    }

    delete runtime;
  }
                     

• Compile:
• g++ -I <HTGS_INSTALL_DIR>/include main.cpp -std=c++11 -pthread


• Sample Output:
• :$./a.out
• Result: 0
• Result: 2
• Result: 4
• Result: 6
• Result: 8
• Result: 10
• Result: 12
• Result: 14
• Result: 16
• Result: 18

Full Documentation

For full explanation of Tutorial 1 and other tutorials showing how to use all of the components, please visit the doxygen documentation below.

• HTGS API:
• Bookkeeper | ExecutionPipeline | ICudaTask | ICustomEdge | IData | IMemoryAllocator
• IMemoryReleaseRule | IRule | ITask | MemoryData | Runtime | TaskGraph | VoidData

More on Doxygen

Cite Us In Your Research

If you are using the HTGS API in your research please use the following references to cite us.

Blattner T., Keyrouz W., The Hybrid Task Graph Scheduler API, (2017), GitHub repository, https:// github.com/usnistgov/HTGS

Blattner, T., Keyrouz, W., Bhattacharyya, S.S. et al. J Sign Process Syst (2017) 89: 457. https://doi.org/10.1007/s11265-017-1262-6