Shape.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __NNFW_MISC_TENSOR_SHAPE_H__
#define __NNFW_MISC_TENSOR_SHAPE_H__
 
#include <cstdint>
#include <cstddef>
#include <deque>
#include <initializer_list>
#include <ostream>
#include <string>
#include <cassert>
 
namespace nnfw
{
namespace misc
{
namespace tensor
{
 
class Shape
{
public:
  Shape(uint32_t rank) { _dimensions.resize(rank); }
 
public:
  Shape(const std::initializer_list<int32_t> &dimensions) : _dimensions{dimensions}
  {
    // Check overflow because initializer_list type can be larger size than max of uint32_t
    assert(dimensions.size() <= 0xFFFFFFFF);
  }
 
  Shape(const Shape &origin) = default;
 
public:
  void prepend(int32_t d) { _dimensions.emplace_front(d); }
 
  void append(int32_t d) { _dimensions.emplace_back(d); }
 
public:
  uint32_t rank(void) const { return static_cast<uint32_t>(_dimensions.size()); }
 
public:
  int32_t dim(uint32_t n) const { return _dimensions.at(n); }
 
  int32_t &dim(uint32_t n) { return _dimensions.at(n); }
 
  const std::deque<int32_t> &dims() const { return _dimensions; }
 
public:
  uint64_t num_elements() const;
 
private:
  std::deque<int32_t> _dimensions;
 
public:
  static Shape from(const std::string &s);
};
 
bool operator==(const Shape &, const Shape &);
 
std::ostream &operator<<(std::ostream &os, const Shape &shape);
 
} // namespace tensor
} // namespace misc
} // namespace nnfw
 
#endif // __NNFW_MISC_TENSOR_SHAPE_H__