armadillo-code/include/armadillo_bits/SpValProxy_meat.hpp

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


//! SpValProxy implementation.
template<typename T1>
arma_inline
SpValProxy<T1>::SpValProxy(uword in_row, uword in_col, T1& in_parent, eT* in_val_ptr)
  : row(in_row)
  , col(in_col)
  , val_ptr(in_val_ptr)
  , parent(in_parent)
  {
  // Nothing to do.
  }



template<typename T1>
arma_inline
SpValProxy<T1>&
SpValProxy<T1>::operator=(const SpValProxy<T1>& rhs)
  {
  return (*this).operator=(eT(rhs));
  }



template<typename T1>
template<typename T2>
arma_inline
SpValProxy<T1>&
SpValProxy<T1>::operator=(const SpValProxy<T2>& rhs)
  {
  return (*this).operator=(eT(rhs));
  }



template<typename T1>
inline
SpValProxy<T1>&
SpValProxy<T1>::operator=(const eT rhs)
  {
  if(rhs != eT(0)) // A nonzero element is being assigned.
    {
    if(val_ptr)
      {
      // The value exists and merely needs to be updated.
      *val_ptr = rhs;
      parent.invalidate_cache();
      }
    else
      {
      // The value is nonzero and must be inserted.
      val_ptr = &parent.insert_element(row, col, rhs);
      }
    }
  else // A zero is being assigned.~
    {
    if(val_ptr)
      {
      // The element exists, but we need to remove it, because it is being set to 0.
      parent.delete_element(row, col);
      val_ptr = nullptr;
      }
    
    // If the element does not exist, we do not need to do anything at all.
    }
  
  return *this;
  }



template<typename T1>
inline
SpValProxy<T1>&
SpValProxy<T1>::operator+=(const eT rhs)
  {
  if(val_ptr)
    {
    // The value already exists and merely needs to be updated.
    *val_ptr += rhs;
    parent.invalidate_cache();
    check_zero();
    }
  else
    {
    if(rhs != eT(0))
      {
      // The value does not exist and must be inserted.
      val_ptr = &parent.insert_element(row, col, rhs);
      }
    }
  
  return *this;
  }



template<typename T1>
inline
SpValProxy<T1>&
SpValProxy<T1>::operator-=(const eT rhs)
  {
  if(val_ptr)
    {
    // The value already exists and merely needs to be updated.
    *val_ptr -= rhs;
    parent.invalidate_cache();
    check_zero();
    }
  else
    {
    if(rhs != eT(0))
      {
      // The value does not exist and must be inserted.
      val_ptr = &parent.insert_element(row, col, -rhs);
      }
    }
  
  return *this;
  }



template<typename T1>
inline
SpValProxy<T1>&
SpValProxy<T1>::operator*=(const eT rhs)
  {
  if(val_ptr)
    {
    *val_ptr *= rhs;
    parent.invalidate_cache();
    check_zero();
    }
  else
    {
    const eT val = eT(0) * rhs;  // in case rhs is inf or nan
    
    if(val != eT(0))  { val_ptr = &parent.insert_element(row, col, val); }
    }
  
  return *this;
  }



template<typename T1>
inline
SpValProxy<T1>&
SpValProxy<T1>::operator/=(const eT rhs)
  {
  if(val_ptr)
    {
    *val_ptr /= rhs;
    parent.invalidate_cache();
    check_zero();
    }
  else
    {
    const eT val = eT(0) / rhs;  // in case rhs is zero or nan
    
    if(val != eT(0))  { val_ptr = &parent.insert_element(row, col, val); }
    }
  
  return *this;
  }



template<typename T1>
inline
SpValProxy<T1>&
SpValProxy<T1>::operator++()
  {
  if(val_ptr)
    {
    (*val_ptr) += eT(1);
    parent.invalidate_cache();
    check_zero();
    }
  else
    {
    val_ptr = &parent.insert_element(row, col, eT(1));
    }
  
  return *this;
  }



template<typename T1>
inline
SpValProxy<T1>&
SpValProxy<T1>::operator--()
  {
  if(val_ptr)
    {
    (*val_ptr) -= eT(1);
    parent.invalidate_cache();
    check_zero();
    }
  else
    {
    val_ptr = &parent.insert_element(row, col, eT(-1));
    }
  
  return *this;
  }



template<typename T1>
inline
typename T1::elem_type
SpValProxy<T1>::operator++(const int)
  {
  if(val_ptr)
    {
    (*val_ptr) += eT(1);
    parent.invalidate_cache();
    check_zero();
    }
  else
    {
    val_ptr = &parent.insert_element(row, col, eT(1));
    }
  
  if(val_ptr) // It may have changed to now be 0.
    {
    return *(val_ptr) - eT(1);
    }
  else
    {
    return eT(0);
    }
  }



template<typename T1>
inline
typename T1::elem_type
SpValProxy<T1>::operator--(const int)
  {
  if(val_ptr)
    {
    (*val_ptr) -= eT(1);
    parent.invalidate_cache();
    check_zero();
    }
  else
    {
    val_ptr = &parent.insert_element(row, col, eT(-1));
    }
  
  if(val_ptr) // It may have changed to now be 0.
    {
    return *(val_ptr) + eT(1);
    }
  else
    {
    return eT(0);
    }
  }



template<typename T1>
arma_inline
SpValProxy<T1>::operator eT() const
  {
  return (val_ptr) ? eT(*val_ptr) : eT(0);
  }



template<typename T1>
arma_inline
typename get_pod_type<typename SpValProxy<T1>::eT>::result
SpValProxy<T1>::real() const
  {
  typedef typename get_pod_type<eT>::result T;
  
  return T( access::tmp_real( (val_ptr) ? eT(*val_ptr) : eT(0) ) );
  }



template<typename T1>
arma_inline
typename get_pod_type<typename SpValProxy<T1>::eT>::result
SpValProxy<T1>::imag() const
  {
  typedef typename get_pod_type<eT>::result T;
  
  return T( access::tmp_imag( (val_ptr) ? eT(*val_ptr) : eT(0) ) );
  }



template<typename T1>
arma_inline
void
SpValProxy<T1>::check_zero()
  {
  if(*val_ptr == eT(0))
    {
    parent.delete_element(row, col);
    val_ptr = nullptr;
    }
  }



//! @}