Program Listing for File constants.h

↰ Return to documentation for file (include/constants.h)

#ifndef MINDSPORE_CCSRC_MINDDATA_DATASET_INCLUDE_DATASET_CONSTANTS_H_
#define MINDSPORE_CCSRC_MINDDATA_DATASET_INCLUDE_DATASET_CONSTANTS_H_

#include <cstdint>
#include <limits>
#include <random>

namespace mindspore {
namespace dataset {
// Various type defines for convenience
using uchar = unsigned char;
using dsize_t = int64_t;

enum class MapTargetDevice {
  kCpu,
  kGpu,
  kAscend310
};

enum class TensorImpl {
  kNone,
  kFlexible,
  kCv,
  kNP
};

enum class ShuffleMode {
  kFalse = 0,
  kFiles = 1,
  kGlobal = 2,
  kInfile = 3
};

enum class BorderType {
  kConstant = 0,
  kEdge = 1,
  kReflect = 2,
  kSymmetric = 3
};

enum class ImageBatchFormat {
  kNHWC = 0,
  kNCHW = 1
};

enum class ImageFormat {
  HWC = 0,
  CHW = 1,
  HW = 2
};

enum class InterpolationMode {
  kLinear = 0,
  kNearestNeighbour = 1,
  kCubic = 2,
  kArea = 3,
  kCubicPil = 4
};

enum class JiebaMode {
  kMix = 0,
  kMp = 1,
  kHmm = 2
};

enum class SPieceTokenizerOutType {
  kString = 0,
  kInt = 1
};

enum class SPieceTokenizerLoadType {
  kFile = 0,
  kModel = 1
};

enum class SentencePieceModel {
  kUnigram = 0,
  kBpe = 1,
  kChar = 2,
  kWord = 3
};

enum class NormalizeForm {
  kNone = 0,
  kNfc,
  kNfkc,
  kNfd,
  kNfkd,
};

enum class RelationalOp {
  kEqual = 0,
  kNotEqual,
  kLess,
  kLessEqual,
  kGreater,
  kGreaterEqual,
};

enum class SliceMode {
  kPad = 0,
  kDrop = 1,
};

enum class SamplingStrategy {
  kRandom = 0,
  kEdgeWeight = 1
};

enum class OutputFormat {
  kNormal = 0,
  kCoo = 1,
  kCsr = 2
};

// convenience functions for 32bit int bitmask
inline bool BitTest(uint32_t bits, uint32_t bitMask) { return (bits & bitMask) == bitMask; }

inline void BitSet(uint32_t *bits, uint32_t bitMask) {
  if (bits == nullptr) {
    return;
  }
  *bits |= bitMask;
}

inline void BitClear(uint32_t *bits, uint32_t bitMask) {
  if (bits == nullptr) {
    return;
  }
  *bits &= (~bitMask);
}

constexpr int64_t kDeMaxDim = std::numeric_limits<int64_t>::max();
constexpr int32_t kDeMaxRank = std::numeric_limits<int32_t>::max();
constexpr int64_t kDeMaxFreq = std::numeric_limits<int64_t>::max();  // 9223372036854775807 or 2^(64-1)
constexpr int64_t kDeMaxTopk = std::numeric_limits<int64_t>::max();

constexpr uint32_t kCfgRowsPerBuffer = 1;
constexpr uint32_t kCfgParallelWorkers = 8;
constexpr uint32_t kCfgWorkerConnectorSize = 16;
constexpr uint32_t kCfgOpConnectorSize = 16;
constexpr uint32_t kCfgSendingBatch = 0;
constexpr int32_t kCfgDefaultRankId = -1;
constexpr uint32_t kCfgDefaultSeed = std::mt19937::default_seed;
constexpr uint32_t kCfgMonitorSamplingInterval = 1000;  // timeout value for sampling interval in milliseconds
constexpr uint32_t kCfgCallbackTimeout = 60;            // timeout value for callback in seconds
constexpr int32_t kCfgDefaultCachePort = 50052;
constexpr char kCfgDefaultCacheHost[] = "127.0.0.1";
constexpr int32_t kDftPrefetchSize = 20;
constexpr int32_t kDftNumConnections = 12;
constexpr int32_t kDftAutoNumWorkers = false;
constexpr char kDftMetaColumnPrefix[] = "_meta-";
constexpr int32_t kDecimal = 10;  // used in strtol() to convert a string value according to decimal numeral system
constexpr int32_t kMinLegalPort = 1025;
constexpr int32_t kMaxLegalPort = 65535;

// Invalid OpenCV type should not be from 0 to 7 (opencv4/opencv2/core/hal/interface.h)
constexpr uint8_t kCVInvalidType = 255;

using connection_id_type = uint64_t;
using session_id_type = uint32_t;
using row_id_type = int64_t;
}  // namespace dataset
}  // namespace mindspore

#endif  // MINDSPORE_CCSRC_MINDDATA_DATASET_INCLUDE_DATASET_CONSTANTS_H_