/* ******************************************************************************
 *
 *
 * 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.
 *
 *  See the NOTICE file distributed with this work for additional
 *  information regarding copyright ownership.
 * 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_SHAPEBUILDERS_H
#define DEV_TESTS_SHAPEBUILDERS_H
#include <array/ArrayOptions.h>
#include <array/DataType.h>
#include <helpers/shape.h>
#include <memory/Workspace.h>

#include <vector>

#include "array/ShapeDescriptor.h"

namespace sd {
class SD_LIB_EXPORT ShapeBuilders {
 public:

  static LongType* createShapeInfo(const DataType dataType, const char order, int rank, const LongType* shape,
                     memory::Workspace* workspace = nullptr, bool empty = false);

  static LongType* copyShapeInfoWithNewType(const LongType* inShapeInfo, const DataType newType);

  static LongType* createShapeInfoFrom(ShapeDescriptor* descriptor);

  static LongType* createScalarShapeInfo(DataType dataType, memory::Workspace* workspace = nullptr);

  static LongType* createVectorShapeInfo(const DataType dataType, const LongType length,
                                         memory::Workspace* workspace = nullptr);


  static LongType* createShapeInfo(const DataType dataType, const char order,
                                       const std::vector<LongType>& shapeOnly,
                                       memory::Workspace* workspace = nullptr);
  static LongType* createShapeInfo(const DataType dataType, const char order,
                                       const std::initializer_list<LongType>& shapeOnly,
                                       memory::Workspace* workspace = nullptr);

  static LongType  * createShapeInfo(const DataType dataType, const char order, int rank,
                                           const LongType* shapeOnly,
                                           const LongType *strideOnly,
                                           memory::Workspace* workspace, sd::LongType extras);


  /**
   *   allocates memory for new shapeInfo and copy all information from inShapeInfo to new shapeInfo
   *   if copyStrides is false then strides for new shapeInfo are recalculated
   */
  static LongType* copyShapeInfo(const LongType* inShapeInfo, const bool copyStrides,
                                     memory::Workspace* workspace = nullptr);
  static LongType* copyShapeInfoAndType(const LongType* inShapeInfo, const DataType dtype,
                                            const bool copyStrides, memory::Workspace* workspace = nullptr);
  static LongType* copyShapeInfoAndType(const LongType* inShapeInfo, const LongType* shapeInfoToGetTypeFrom,
                                            const bool copyStrides, memory::Workspace* workspace = nullptr);

  /**
   * allocates memory for sub-array shapeInfo and copy shape and strides at axes(positions) stored in dims
   */
  static LongType* createSubArrShapeInfo(const LongType* inShapeInfo, const LongType* dims, const int dimsSize,
                                             memory::Workspace* workspace = nullptr);

  static LongType* emptyShapeInfo(const DataType dataType, memory::Workspace* workspace = nullptr);

  static LongType* emptyShapeInfo(const DataType dataType, const char order,
                                      const std::vector<LongType>& shape, memory::Workspace* workspace = nullptr);

  static LongType* emptyShapeInfo(const DataType dataType, const char order, int rank,
                                      const LongType* shapeOnly, memory::Workspace* workspace = nullptr);

  static LongType* emptyShapeInfoWithShape(const DataType dataType, std::vector<LongType>& shape,
                                    memory::Workspace* workspace);
  static LongType* setAsView(const LongType* inShapeInfo);
};
}  // namespace sd

#endif  // DEV_TESTS_SHAPEBUILDERS_H