// Copyright (c) 2017, Lawrence Livermore National Security, LLC.
// Produced at the Lawrence Livermore National Laboratory (LLNL).
// Written by Cosmin G. Petra, petra1@llnl.gov.
// LLNL-CODE-742473. All rights reserved.
//
// This file is part of HiOp. For details, see https://github.com/LLNL/hiop. HiOp 
// is released under the BSD 3-clause license (https://opensource.org/licenses/BSD-3-Clause). 
// Please also read “Additional BSD Notice” below.
//
// Redistribution and use in source and binary forms, with or without modification, 
// are permitted provided that the following conditions are met:
// i. Redistributions of source code must retain the above copyright notice, this list 
// of conditions and the disclaimer below.
// ii. Redistributions in binary form must reproduce the above copyright notice, 
// this list of conditions and the disclaimer (as noted below) in the documentation and/or 
// other materials provided with the distribution.
// iii. Neither the name of the LLNS/LLNL nor the names of its contributors may be used to 
// endorse or promote products derived from this software without specific prior written 
// permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
// SHALL LAWRENCE LIVERMORE NATIONAL SECURITY, LLC, THE U.S. DEPARTMENT OF ENERGY OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 
// OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
// AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
// EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Additional BSD Notice
// 1. This notice is required to be provided under our contract with the U.S. Department 
// of Energy (DOE). This work was produced at Lawrence Livermore National Laboratory under 
// Contract No. DE-AC52-07NA27344 with the DOE.
// 2. Neither the United States Government nor Lawrence Livermore National Security, LLC 
// nor any of their employees, makes any warranty, express or implied, or assumes any 
// liability or responsibility for the accuracy, completeness, or usefulness of any 
// information, apparatus, product, or process disclosed, or represents that its use would
// not infringe privately-owned rights.
// 3. Also, reference herein to any specific commercial products, process, or services by 
// trade name, trademark, manufacturer or otherwise does not necessarily constitute or 
// imply its endorsement, recommendation, or favoring by the United States Government or 
// Lawrence Livermore National Security, LLC. The views and opinions of authors expressed 
// herein do not necessarily state or reflect those of the United States Government or 
// Lawrence Livermore National Security, LLC, and shall not be used for advertising or 
// product endorsement purposes.

#pragma once

/**
 * @file hiopVectorIntCuda.hpp
 *
 * @author Nai-Yuan Chiang <chiang7@llnl.gov>, LLNL
 */

#include "hiopVectorInt.hpp"
#include "ExecSpace.hpp"
#include <string>

namespace hiop
{

// "forward" declarations
class hiopVectorIntSeq;
  
class hiopVectorIntCuda : public hiopVectorInt
{
public:
  hiopVectorIntCuda(size_type sz, std::string mem_space="HOST");

  ~hiopVectorIntCuda();

  virtual inline index_type* local_data_host() { return buf_host_; }

  virtual inline const index_type* local_data_host_const() const { return buf_host_; }

  virtual inline index_type* local_data() { return buf_; }

  virtual inline const index_type* local_data_const() const { return buf_; }
  
  virtual void copy_from(const index_type* v_local);

  virtual void copy_from_vectorseq(const hiopVectorIntSeq& src);
  virtual void copy_to_vectorseq(hiopVectorIntSeq& dest) const;

  /// @brief Set all elements to zero.
  virtual void set_to_zero();

  /// @brief Set all elements  to  c
  virtual void set_to_constant(const index_type c);

  /**
   * @brief Set the vector entries to be a linear space of starting at i0 containing evenly 
   * incremented integers up to i0+(n-1)di, when n is the length of this vector
   *
   * @pre The elements of the linear space should not overflow the index_type type
   *  
   * @param i0 the starting element in the linear space (entry 0 in vector)
   * @param di the increment for subsequent entries in the vector
   *
   */ 
  virtual void linspace(const index_type& i0, const index_type& di);

  ExecSpace<MemBackendCuda, ExecPolicyCuda>& exec_space()
  {
    return exec_space_;
  }
  const ExecSpace<MemBackendCuda, ExecPolicyCuda>& exec_space() const
  {
    return exec_space_;
  }

private:
  ExecSpace<MemBackendCuda, ExecPolicyCuda> exec_space_;
  ExecSpace<MemBackendCpp, ExecPolicySeq> exec_space_host_;

  index_type *buf_host_;
  index_type *buf_;
};

} // namespace hiop
