pulsatrix/api/top__k_8hpp_source.html

#pragma once


#include <cstdint>


#include "pulsatrix/tensor.hpp"


namespace pulsatrix {


struct TopKResult {

    Tensor values;

    Tensor indices;

};


[[nodiscard]] TopKResult top_k(const Tensor& input, int64_t k, bool largest = true);


}  // namespace pulsatrix

pulsatrix::Tensor
N-dimensional tensor. Owns its data buffer exclusively; a DeviceBackend* is injected (not owned) – th...
Definition tensor.hpp:29

pulsatrix
Definition acquisition_functions.hpp:16

pulsatrix::top_k
TopKResult top_k(const Tensor &input, int64_t k, bool largest=true)
Selects the k largest (or smallest) entries of every row along the last dimension.

pulsatrix::TopKResult
top_k()'s result: the selected values and their positions along the last dimension.
Definition top_k.hpp:14

pulsatrix::TopKResult::indices
Tensor indices
Shape (..., k): each value's index within its row, as a whole-number float.
Definition top_k.hpp:18

pulsatrix::TopKResult::values
Tensor values
Shape (..., k): each row's k best values, best first.
Definition top_k.hpp:16

tensor.hpp
N-dimensional tensor – owns a buffer via DeviceBackend*, RAII (Rule of Five).