cavis/libnd4j/include/array/ShapeDescriptor.h

124 lines
4.6 KiB
C++

/*******************************************************************************
* Copyright (c) 2015-2018 Skymind, Inc.
* Copyright (c) 2019-2020 Konduit K.K.
*
* This program and the accompanying materials are made available under the
* terms of the Apache License, Version 2.0 which is available at
* https://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.
*
* SPDX-License-Identifier: Apache-2.0
******************************************************************************/
//
// @author raver119@gmail.com
// @author AbdelRauf
#ifndef DEV_TESTS_SHAPEDESCRIPTOR_H
#define DEV_TESTS_SHAPEDESCRIPTOR_H
#include <unordered_map>
#include <vector>
#include <system/dll.h>
#include <system/pointercast.h>
#include <array/ArrayOptions.h>
#include <array/DataType.h>
#include <initializer_list>
namespace sd {
#define SHAPE_DESC_OK 0
#define SHAPE_DESC_INCORRECT_STRIDES 1 //strides does not match shapes
#define SHAPE_DESC_INCORRECT_EWS 2 //ews neither matches stride nor continuity
#define SHAPE_DESC_INCORRECT_RANK 4 //rank > 32 or shape size and rank does not match
class ND4J_EXPORT ShapeDescriptor {
private:
int _rank = 0;
std::vector<Nd4jLong> _shape;
std::vector<Nd4jLong> _strides;
Nd4jLong _ews = 1;
char _order = 'c';
DataType _dataType;
Nd4jLong _extraProperties = 0;
Nd4jLong _paddedAllocSize = 0;
public:
ShapeDescriptor(const ShapeDescriptor &other);
ShapeDescriptor(const Nd4jLong *shapeInfo, bool inheritDtype = true);
explicit ShapeDescriptor(const Nd4jLong *shapeInfo, const sd::DataType dtypeOverride);
explicit ShapeDescriptor(const Nd4jLong *shapeInfo, const Nd4jLong *dtypeOverride);
explicit ShapeDescriptor(const Nd4jLong *shapeInfo, const Nd4jLong *dtypeOverride, const Nd4jLong *orderOverride);
explicit ShapeDescriptor(const DataType type, const Nd4jLong length);
explicit ShapeDescriptor(const DataType type, const char order, const Nd4jLong *shape, const int rank);
explicit ShapeDescriptor(const DataType type, const char order, const std::initializer_list<Nd4jLong> &shape);
explicit ShapeDescriptor(const DataType type, const char order, const std::vector<Nd4jLong> &shape);
explicit ShapeDescriptor(const DataType type, const char order, const std::vector<Nd4jLong> &shape, const std::vector<Nd4jLong> &strides);
explicit ShapeDescriptor(const DataType type, const char order, const std::vector<Nd4jLong> &shape, const std::vector<Nd4jLong> &strides, const Nd4jLong ews);
explicit ShapeDescriptor(const DataType type, const char order, const Nd4jLong *shape, const Nd4jLong *strides, const int rank, Nd4jLong ews, Nd4jLong extras);
ShapeDescriptor() = default;
~ShapeDescriptor() = default;
int rank() const;
Nd4jLong ews() const;
Nd4jLong arrLength() const;
char order() const;
DataType dataType() const;
bool isEmpty() const;
std::vector<Nd4jLong>& shape();
std::vector<Nd4jLong>& strides();
//returns minimal allocation length
Nd4jLong allocLength() const;
//returns Status for the correctness
Nd4jLong validate() const;
// we use default copy assignment operator
ShapeDescriptor& operator=(const ShapeDescriptor& other) = default;
// we use default move assignment operator
ShapeDescriptor& operator=(ShapeDescriptor&& other) noexcept = default;
// equal to operator
bool operator==(const ShapeDescriptor &other) const;
// less than operator
bool operator<(const ShapeDescriptor &other) const;
Nd4jLong* toShapeInfo() const;
static ShapeDescriptor emptyDescriptor(const DataType type);
static ShapeDescriptor scalarDescriptor(const DataType type);
static ShapeDescriptor vectorDescriptor(const Nd4jLong length, const DataType type);
//create Descriptor with padded buffer.
static ShapeDescriptor paddedBufferDescriptor(const DataType type, const char order, const std::vector<Nd4jLong>& shape, const std::vector<Nd4jLong>& paddings);
};
}
#ifndef __JAVACPP_HACK__
namespace std {
template<>
class ND4J_EXPORT hash<sd::ShapeDescriptor> {
public:
size_t operator()(const sd::ShapeDescriptor &k) const;
};
}
#endif
#endif //DEV_TESTS_SHAPEDESCRIPTOR_H