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

template <typename eT>
inline SpRow<eT>::SpRow() : SpMat<eT>(arma_vec_indicator(), 2) {
  arma_extra_debug_sigprint();
}

template <typename eT>
inline SpRow<eT>::SpRow(const uword in_n_elem)
    : SpMat<eT>(arma_vec_indicator(), 1, in_n_elem, 2) {
  arma_extra_debug_sigprint();
}

template <typename eT>
inline SpRow<eT>::SpRow(const uword in_n_rows, const uword in_n_cols)
    : SpMat<eT>(arma_vec_indicator(), in_n_rows, in_n_cols, 2) {
  arma_extra_debug_sigprint();
}

template <typename eT>
inline SpRow<eT>::SpRow(const SizeMat& s) : SpMat<eT>(arma_vec_indicator(), 0, 0, 2) {
  arma_extra_debug_sigprint();

  SpMat<eT>::init(s.n_rows, s.n_cols);
}

template <typename eT>
inline SpRow<eT>::SpRow(const char* text) : SpMat<eT>(arma_vec_indicator(), 2) {
  arma_extra_debug_sigprint();

  SpMat<eT>::init(std::string(text));
}

template <typename eT>
inline SpRow<eT>& SpRow<eT>::operator=(const char* text) {
  arma_extra_debug_sigprint();

  SpMat<eT>::init(std::string(text));

  return *this;
}

template <typename eT>
inline SpRow<eT>::SpRow(const std::string& text) : SpMat<eT>(arma_vec_indicator(), 2) {
  arma_extra_debug_sigprint();

  SpMat<eT>::init(text);
}

template <typename eT>
inline SpRow<eT>& SpRow<eT>::operator=(const std::string& text) {
  arma_extra_debug_sigprint();

  SpMat<eT>::init(text);

  return *this;
}

template <typename eT>
inline SpRow<eT>& SpRow<eT>::operator=(const eT val) {
  arma_extra_debug_sigprint();

  SpMat<eT>::operator=(val);

  return *this;
}

template <typename eT>
template <typename T1>
inline SpRow<eT>::SpRow(const Base<eT, T1>& X) : SpMat<eT>(arma_vec_indicator(), 2) {
  arma_extra_debug_sigprint();

  SpMat<eT>::operator=(X.get_ref());
}

template <typename eT>
template <typename T1>
inline SpRow<eT>& SpRow<eT>::operator=(const Base<eT, T1>& X) {
  arma_extra_debug_sigprint();

  SpMat<eT>::operator=(X.get_ref());

  return *this;
}

template <typename eT>
template <typename T1>
inline SpRow<eT>::SpRow(const SpBase<eT, T1>& X) : SpMat<eT>(arma_vec_indicator(), 2) {
  arma_extra_debug_sigprint();

  SpMat<eT>::operator=(X.get_ref());
}

template <typename eT>
template <typename T1>
inline SpRow<eT>& SpRow<eT>::operator=(const SpBase<eT, T1>& X) {
  arma_extra_debug_sigprint();

  SpMat<eT>::operator=(X.get_ref());

  return *this;
}

template <typename eT>
template <typename T1, typename T2>
inline SpRow<eT>::SpRow(const SpBase<typename SpRow<eT>::pod_type, T1>& A,
                        const SpBase<typename SpRow<eT>::pod_type, T2>& B)
    : SpMat<eT>(arma_vec_indicator(), 2) {
  arma_extra_debug_sigprint();

  SpMat<eT>::init(A, B);
}

template <typename eT>
inline const SpOp<SpRow<eT>, spop_htrans> SpRow<eT>::t() const {
  return SpOp<SpRow<eT>, spop_htrans>(*this);
}

template <typename eT>
inline const SpOp<SpRow<eT>, spop_htrans> SpRow<eT>::ht() const {
  return SpOp<SpRow<eT>, spop_htrans>(*this);
}

template <typename eT>
inline const SpOp<SpRow<eT>, spop_strans> SpRow<eT>::st() const {
  return SpOp<SpRow<eT>, spop_strans>(*this);
}

//! remove specified columns
template <typename eT>
inline void SpRow<eT>::shed_col(const uword col_num) {
  arma_extra_debug_sigprint();

  arma_debug_check_bounds(col_num >= SpMat<eT>::n_cols,
                          "SpRow::shed_col(): out of bounds");

  shed_cols(col_num, col_num);
}

//! remove specified columns
template <typename eT>
inline void SpRow<eT>::shed_cols(const uword in_col1, const uword in_col2) {
  arma_extra_debug_sigprint();

  arma_debug_check_bounds(
      (in_col1 > in_col2) || (in_col2 >= SpMat<eT>::n_cols),
      "SpRow::shed_cols(): indices out of bounds or incorrectly used");

  SpMat<eT>::sync_csc();

  const uword diff = (in_col2 - in_col1 + 1);

  // This is doubleplus easy because we have all the column pointers stored.
  const uword start = SpMat<eT>::col_ptrs[in_col1];
  const uword end = SpMat<eT>::col_ptrs[in_col2 + 1];

  if (start != end) {
    const uword elem_diff = end - start;

    eT* new_values = memory::acquire<eT>(SpMat<eT>::n_nonzero - elem_diff);
    uword* new_row_indices = memory::acquire<uword>(SpMat<eT>::n_nonzero - elem_diff);

    // Copy first set of elements, if necessary.
    if (start > 0) {
      arrayops::copy(new_values, SpMat<eT>::values, start);
      arrayops::copy(new_row_indices, SpMat<eT>::row_indices, start);
    }

    // Copy last set of elements, if necessary.
    if (end != SpMat<eT>::n_nonzero) {
      arrayops::copy(new_values + start, SpMat<eT>::values + end,
                     (SpMat<eT>::n_nonzero - end));
      arrayops::copy(new_row_indices + start, SpMat<eT>::row_indices + end,
                     (SpMat<eT>::n_nonzero - end));
    }

    memory::release(SpMat<eT>::values);
    memory::release(SpMat<eT>::row_indices);

    access::rw(SpMat<eT>::values) = new_values;
    access::rw(SpMat<eT>::row_indices) = new_row_indices;

    access::rw(SpMat<eT>::n_nonzero) -= elem_diff;
  }

  // Update column pointers.
  uword* new_col_ptrs = memory::acquire<uword>(SpMat<eT>::n_cols - diff + 1);

  // Copy first part of column pointers.
  if (in_col1 > 0) {
    arrayops::copy(new_col_ptrs, SpMat<eT>::col_ptrs, in_col1);
  }

  // Copy last part of column pointers (and adjust their values as necessary).
  if (in_col2 < SpMat<eT>::n_cols - 1) {
    arrayops::copy(new_col_ptrs + in_col1, SpMat<eT>::col_ptrs + in_col2 + 1,
                   SpMat<eT>::n_cols - in_col2);
    // Modify their values.
    arrayops::inplace_minus(new_col_ptrs + in_col1, (end - start),
                            SpMat<eT>::n_cols - in_col2);
  }

  memory::release(SpMat<eT>::col_ptrs);

  access::rw(SpMat<eT>::col_ptrs) = new_col_ptrs;

  access::rw(SpMat<eT>::n_cols) -= diff;
  access::rw(SpMat<eT>::n_elem) -= diff;

  SpMat<eT>::invalidate_cache();
}

// //! insert N cols at the specified col position,
// //! optionally setting the elements of the inserted cols to zero
// template<typename eT>
// inline
// void
// SpRow<eT>::insert_cols(const uword col_num, const uword N, const bool set_to_zero)
//   {
//   arma_extra_debug_sigprint();
//
//   // insertion at col_num == n_cols is in effect an append operation
//   arma_debug_check_bounds( (col_num > SpMat<eT>::n_cols), "SpRow::insert_cols(): out of
//   bounds" );
//
//   arma_debug_check( (set_to_zero == false), "SpRow::insert_cols(): cannot set elements
//   to nonzero values" );
//
//   uword newVal = (col_num == 0) ? 0 : SpMat<eT>::col_ptrs[col_num];
//   SpMat<eT>::col_ptrs.insert(col_num, N, newVal);
//   uword* new_col_ptrs = memory::acquire<uword>(SpMat<eT>::n_cols + N);
//
//   arrayops::copy(new_col_ptrs, SpMat<eT>::col_ptrs, col_num);
//
//   uword fill_value = (col_num == 0) ? 0 : SpMat<eT>::col_ptrs[col_num - 1];
//   arrayops::inplace_set(new_col_ptrs + col_num, fill_value, N);
//
//   arrayops::copy(new_col_ptrs + col_num + N, SpMat<eT>::col_ptrs + col_num,
//   SpMat<eT>::n_cols - col_num);
//
//   access::rw(SpMat<eT>::n_cols) += N;
//   access::rw(SpMat<eT>::n_elem) += N;
//   }

template <typename eT>
inline typename SpRow<eT>::row_iterator SpRow<eT>::begin_row(const uword row_num) {
  arma_extra_debug_sigprint();

  // Since this is a row, row_num can only be 0.  But the option is provided for
  // compatibility.
  arma_debug_check_bounds((row_num >= 1), "SpRow::begin_row(): index out of bounds");

  return SpMat<eT>::begin();
}

template <typename eT>
inline typename SpRow<eT>::const_row_iterator SpRow<eT>::begin_row(
    const uword row_num) const {
  arma_extra_debug_sigprint();

  // Since this is a row, row_num can only be 0.  But the option is provided for
  // compatibility.
  arma_debug_check_bounds((row_num >= 1), "SpRow::begin_row(): index out of bounds");

  return SpMat<eT>::begin();
}

template <typename eT>
inline typename SpRow<eT>::row_iterator SpRow<eT>::end_row(const uword row_num) {
  arma_extra_debug_sigprint();

  // Since this is a row, row_num can only be 0.  But the option is provided for
  // compatibility.
  arma_debug_check_bounds((row_num >= 1), "SpRow::end_row(): index out of bounds");

  return SpMat<eT>::end();
}

template <typename eT>
inline typename SpRow<eT>::const_row_iterator SpRow<eT>::end_row(
    const uword row_num) const {
  arma_extra_debug_sigprint();

  // Since this is a row, row_num can only be 0.  But the option is provided for
  // compatibility.
  arma_debug_check_bounds((row_num >= 1), "SpRow::end_row(): index out of bounds");

  return SpMat<eT>::end();
}

#if defined(ARMA_EXTRA_SPROW_MEAT)
#include ARMA_INCFILE_WRAP(ARMA_EXTRA_SPROW_MEAT)
#endif

//! @}
