// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au)
// Copyright 2008-2016 National ICT Australia (NICTA)
//
// 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.
// ------------------------------------------------------------------------

//! \addtogroup fn_zeros
//! @{

arma_warn_unused arma_inline const Gen<vec, gen_zeros> zeros(const uword n_elem) {
  arma_debug_sigprint();

  return Gen<vec, gen_zeros>(n_elem, 1);
}

template <typename obj_type>
arma_warn_unused arma_inline const Gen<obj_type, gen_zeros> zeros(
    const uword n_elem, const arma_empty_class junk1 = arma_empty_class(),
    const typename arma_Mat_Col_Row_only<obj_type>::result* junk2 = nullptr) {
  arma_debug_sigprint();
  arma_ignore(junk1);
  arma_ignore(junk2);

  const uword n_rows = (is_Row<obj_type>::value) ? uword(1) : n_elem;
  const uword n_cols = (is_Row<obj_type>::value) ? n_elem : uword(1);

  return Gen<obj_type, gen_zeros>(n_rows, n_cols);
}

arma_warn_unused arma_inline const Gen<mat, gen_zeros> zeros(const uword n_rows,
                                                             const uword n_cols) {
  arma_debug_sigprint();

  return Gen<mat, gen_zeros>(n_rows, n_cols);
}

arma_warn_unused arma_inline const Gen<mat, gen_zeros> zeros(const SizeMat& s) {
  arma_debug_sigprint();

  return Gen<mat, gen_zeros>(s.n_rows, s.n_cols);
}

template <typename obj_type>
arma_warn_unused arma_inline const Gen<obj_type, gen_zeros> zeros(
    const uword n_rows, const uword n_cols,
    const typename arma_Mat_Col_Row_only<obj_type>::result* junk = nullptr) {
  arma_debug_sigprint();
  arma_ignore(junk);

  if (is_Col<obj_type>::value) {
    arma_conform_check((n_cols != 1), "zeros(): incompatible size");
  }
  if (is_Row<obj_type>::value) {
    arma_conform_check((n_rows != 1), "zeros(): incompatible size");
  }

  return Gen<obj_type, gen_zeros>(n_rows, n_cols);
}

template <typename obj_type>
arma_warn_unused arma_inline const Gen<obj_type, gen_zeros> zeros(
    const SizeMat& s,
    const typename arma_Mat_Col_Row_only<obj_type>::result* junk = nullptr) {
  arma_debug_sigprint();
  arma_ignore(junk);

  return zeros<obj_type>(s.n_rows, s.n_cols);
}

arma_warn_unused arma_inline const GenCube<cube::elem_type, gen_zeros> zeros(
    const uword n_rows, const uword n_cols, const uword n_slices) {
  arma_debug_sigprint();

  return GenCube<cube::elem_type, gen_zeros>(n_rows, n_cols, n_slices);
}

arma_warn_unused arma_inline const GenCube<cube::elem_type, gen_zeros> zeros(
    const SizeCube& s) {
  arma_debug_sigprint();

  return GenCube<cube::elem_type, gen_zeros>(s.n_rows, s.n_cols, s.n_slices);
}

template <typename cube_type>
arma_warn_unused arma_inline const GenCube<typename cube_type::elem_type, gen_zeros>
zeros(const uword n_rows, const uword n_cols, const uword n_slices,
      const typename arma_Cube_only<cube_type>::result* junk = nullptr) {
  arma_debug_sigprint();
  arma_ignore(junk);

  return GenCube<typename cube_type::elem_type, gen_zeros>(n_rows, n_cols, n_slices);
}

template <typename cube_type>
arma_warn_unused arma_inline const GenCube<typename cube_type::elem_type, gen_zeros>
zeros(const SizeCube& s,
      const typename arma_Cube_only<cube_type>::result* junk = nullptr) {
  arma_debug_sigprint();
  arma_ignore(junk);

  return GenCube<typename cube_type::elem_type, gen_zeros>(s.n_rows, s.n_cols,
                                                           s.n_slices);
}

template <typename sp_obj_type>
arma_warn_unused inline sp_obj_type zeros(
    const uword n_rows, const uword n_cols,
    const typename arma_SpMat_SpCol_SpRow_only<sp_obj_type>::result* junk = nullptr) {
  arma_debug_sigprint();
  arma_ignore(junk);

  if (is_SpCol<sp_obj_type>::value) {
    arma_conform_check((n_cols != 1), "zeros(): incompatible size");
  }
  if (is_SpRow<sp_obj_type>::value) {
    arma_conform_check((n_rows != 1), "zeros(): incompatible size");
  }

  return sp_obj_type(n_rows, n_cols);
}

template <typename sp_obj_type>
arma_warn_unused inline sp_obj_type zeros(
    const SizeMat& s,
    const typename arma_SpMat_SpCol_SpRow_only<sp_obj_type>::result* junk = nullptr) {
  arma_debug_sigprint();
  arma_ignore(junk);

  return zeros<sp_obj_type>(s.n_rows, s.n_cols);
}

//! @}
