////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2014-2023, Lawrence Livermore National Security, LLC.
// Produced at the Lawrence Livermore National Laboratory.
// Written by the LBANN Research Team (B. Van Essen, et al.) listed in
// the CONTRIBUTORS file. <lbann-dev@llnl.gov>
//
// LLNL-CODE-697807.
// All rights reserved.
//
// This file is part of LBANN: Livermore Big Artificial Neural Network
// Toolkit. For details, see http://software.llnl.gov/LBANN or
// https://github.com/LLNL/LBANN.
//
// Licensed under the Apache License, Version 2.0 (the "Licensee"); 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.
////////////////////////////////////////////////////////////////////////////////

#ifndef LBANN_LAYER_IN_TOP_K_HPP_INCLUDED
#define LBANN_LAYER_IN_TOP_K_HPP_INCLUDED

#include "lbann/layers/data_type_layer.hpp"
#include "lbann/layers/layer.hpp"
#include "lbann/proto/datatype_helpers.hpp"
#include "lbann/utils/exception.hpp"

#include "lbann/proto/layers.pb.h"

namespace lbann {

/** @brief One-hot vector indicating top-k entries
 *
 *  Output tensor has same dimensions as input tensor. Output entries
 *  corresponding to the top-k input entries are set to one and the
 *  rest to zero. Ties are broken in favor of entries with smaller
 *  indices.
 */
template <typename TensorDataType,
          data_layout T_layout = data_layout::DATA_PARALLEL,
          El::Device Dev = El::Device::CPU>
class in_top_k_layer : public data_type_layer<TensorDataType>
{
public:
  in_top_k_layer(lbann_comm* comm, El::Int k)
    : data_type_layer<TensorDataType>(comm), m_k(k)
  {
    if (m_k < 0) {
      LBANN_ERROR("invalid parameter for top-k search (k=", m_k, ")");
    }
  }

  in_top_k_layer* copy() const override { return new in_top_k_layer(*this); }

  /** @name Serialization */
  ///@{

  template <typename ArchiveT>
  void serialize(ArchiveT& ar);

  ///@}

  std::string get_type() const override { return "in_top_k"; }
  data_layout get_data_layout() const override { return T_layout; }
  El::Device get_device_allocation() const override { return Dev; }

  description get_description() const override
  {
    auto desc = data_type_layer<TensorDataType>::get_description();
    desc.add("k", m_k);
    return desc;
  }

protected:
  /** Add layer specific data to prototext */
  void write_specific_proto(lbann_data::Layer& proto) const final;

  friend class cereal::access;
  in_top_k_layer() : in_top_k_layer(nullptr, 1) {}

  void setup_dims(DataReaderMetaData& dr_metadata) override
  {
    data_type_layer<TensorDataType>::setup_dims(dr_metadata);
    this->set_output_dims(this->get_input_dims());
  }

  void fp_compute() override;

private:
  /** Parameter for top-k search. */
  El::Int m_k;
};

template <typename T, data_layout L, El::Device D>
void in_top_k_layer<T, L, D>::write_specific_proto(
  lbann_data::Layer& proto) const
{
  proto.set_datatype(proto::ProtoDataType<T>);
  auto* msg = proto.mutable_in_top_k();
  msg->set_k(m_k);
}

#ifndef LBANN_IN_TOP_K_LAYER_INSTANTIATE
#define PROTO_DEVICE(T, Device)                                                \
  extern template class in_top_k_layer<T, data_layout::DATA_PARALLEL, Device>; \
  extern template class in_top_k_layer<T, data_layout::MODEL_PARALLEL, Device>

#include "lbann/macros/instantiate_device.hpp"
#undef PROTO_DEVICE
#endif // LBANN_IN_TOP_K_LAYER_INSTANTIATE

} // namespace lbann

#endif // LBANN_LAYER_IN_TOP_K_HPP_INCLUDED
