JobID.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_JOBID_H
#define MYRAMATH_JOBGRAPH_JOBID_H

#include <myramath/MYRAMATH_EXPORT.h>
#include <myramath/utility/detail/ssize.h>

#include <myramath/utility/hashes.h>
#include <myramath/utility/Pack.h>

#include <stdint.h>
#include <vector>
#include <iosfwd>

namespace myra {

// Forward declarations.
class JobID;

MYRAMATH_EXPORT bool operator <  (JobID a, JobID b);
MYRAMATH_EXPORT bool operator >  (JobID a, JobID b);
MYRAMATH_EXPORT bool operator <= (JobID a, JobID b);
MYRAMATH_EXPORT bool operator >= (JobID a, JobID b);
MYRAMATH_EXPORT bool operator == (JobID a, JobID b);
MYRAMATH_EXPORT bool operator != (JobID a, JobID b);

MYRAMATH_EXPORT bool operator <  (JobID a, uint64_t b);
MYRAMATH_EXPORT bool operator >  (JobID a, uint64_t b);
MYRAMATH_EXPORT bool operator <= (JobID a, uint64_t b);
MYRAMATH_EXPORT bool operator >= (JobID a, uint64_t b);
MYRAMATH_EXPORT bool operator == (JobID a, uint64_t b);
MYRAMATH_EXPORT bool operator != (JobID a, uint64_t b);

MYRAMATH_EXPORT std::ostream& operator << (std::ostream& out, JobID j);

} // namespace myra

#ifdef MYRAMATH_ENABLE_CPP11
namespace std { template<> struct hash<myra::JobID>; }
#endif

namespace myra {

class MYRAMATH_EXPORT JobID
  {
  public:

    JobID(uint64_t j) : data(j) { }

    JobID(const Pack<int,1>& size, const Pack<int,1>& index);
    JobID(const Pack<int,2>& size, const Pack<int,2>& index);
    JobID(const Pack<int,3>& size, const Pack<int,3>& index);
    JobID(const Pack<int,4>& size, const Pack<int,4>& index);
    JobID(const Pack<int,5>& size, const Pack<int,5>& index);
    JobID(const Pack<int,6>& size, const Pack<int,6>& index);

    uint64_t unpack() const { return data; }
    int unpack(const Pack<int,1>& size, int index) const;
    int unpack(const Pack<int,2>& size, int index) const;
    int unpack(const Pack<int,3>& size, int index) const;
    int unpack(const Pack<int,4>& size, int index) const;
    int unpack(const Pack<int,5>& size, int index) const;
    int unpack(const Pack<int,6>& size, int index) const;
    
    void operator+= (uint64_t offset);
    void operator-= (uint64_t offset);

  private:

    // Internal representation.
    uint64_t data;

    // Implementation detail of Pack-based constructors.
    template<int N> void constructor_template(const Pack<int,N>& size, const Pack<int,N>& index);

    // Implementation detail of unpack() method.
    template<int N> int unpack_template(const Pack<int,N>& size, int index) const;

    // Friendship for comparing/printing/hashing.
    friend MYRAMATH_EXPORT bool operator < (JobID a, JobID b);
    friend MYRAMATH_EXPORT bool operator > (JobID a, JobID b);
    friend MYRAMATH_EXPORT bool operator <=(JobID a, JobID b);
    friend MYRAMATH_EXPORT bool operator >=(JobID a, JobID b);
    friend MYRAMATH_EXPORT bool operator ==(JobID a, JobID b);    
    friend MYRAMATH_EXPORT bool operator !=(JobID a, JobID b);
    friend MYRAMATH_EXPORT bool operator < (JobID a, uint64_t b);
    friend MYRAMATH_EXPORT bool operator > (JobID a, uint64_t b);
    friend MYRAMATH_EXPORT bool operator <=(JobID a, uint64_t b);
    friend MYRAMATH_EXPORT bool operator >=(JobID a, uint64_t b);
    friend MYRAMATH_EXPORT bool operator ==(JobID a, uint64_t b);    
    friend MYRAMATH_EXPORT bool operator !=(JobID a, uint64_t b);
    friend MYRAMATH_EXPORT std::ostream& operator << (std::ostream& out, JobID j);
    friend struct std::hash<JobID>;
    
  };

typedef std::vector<JobID> JobIDs;

template<int N>
uint64_t product(const Pack<int,N>& p)
  {
  uint64_t pi = 1;
  for (int n = 0; n < N; ++n)
    pi *= p[n];
  return pi;
  }

JobID operator+ (JobID j, uint64_t offset);
JobID operator- (JobID j, uint64_t offset);

} // namespace myra

#ifdef MYRAMATH_ENABLE_CPP11
namespace std {
template<> struct hash <myra::JobID> 
  { 
  size_t operator()(myra::JobID id) const
    { return std::hash<uint64_t>()(id.data); }
  };
} // namespace std;
#endif

#endif