cavis/libnd4j/include/array/TadDescriptor.h

/*******************************************************************************
 * Copyright (c) 2015-2018 Skymind, Inc.
 *
 * 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
//

#ifndef DEV_TESTS_TADDESCRIPTOR_H
#define DEV_TESTS_TADDESCRIPTOR_H

#include "ShapeDescriptor.h"
#include <dll.h>

namespace nd4j {
    class ND4J_EXPORT TadDescriptor {
    private:
        ShapeDescriptor _originalShape;

        std::vector<int> _axis;

        bool _unitiesInShape;

    public:
        explicit TadDescriptor(const Nd4jLong *originalShape, const int *dimensions, const int length, const bool keepUnitiesInShape = false);
        explicit TadDescriptor(const ShapeDescriptor &descriptor, const std::vector<int> &dimensions, const bool keepUnitiesInShape = false);
        explicit TadDescriptor(const TadDescriptor &other);
        ~TadDescriptor() = default;

        // we use default copy assignment operator
        TadDescriptor& operator=(const TadDescriptor& other) = default;

        // we use default move assignment operator
        TadDescriptor& operator=(TadDescriptor&& other) noexcept = default;

        // equal to operator
        bool operator==(const TadDescriptor &other) const;

        // less than operator
        bool operator<(const TadDescriptor &other) const;

        std::vector<int>& axis();
        ShapeDescriptor& originalShape();
        ShapeDescriptor const& originalShapeConst() const;
        bool areUnitiesinShape() const;
    };
}

#ifndef __JAVACPP_HACK__

namespace std {
    template<>
    class ND4J_EXPORT hash<nd4j::TadDescriptor> {
    public:
        size_t operator()(const nd4j::TadDescriptor &k) const;
    };
}

#endif


#endif //DEV_TESTS_TADDESCRIPTOR_H