// 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_eye
//! @{

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

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

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

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

template <typename obj_type>
arma_warn_unused arma_inline const Gen<obj_type, gen_eye> eye(
    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), "eye(): incompatible size");
  }
  if (is_Row<obj_type>::value) {
    arma_conform_check((n_rows != 1), "eye(): incompatible size");
  }

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

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

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

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

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

  obj_type out;

  out.eye(n_rows, n_cols);

  return out;
}

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

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

//! @}
