params.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2018-2026, NVIDIA CORPORATION.
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <raft/linalg/pca_types.hpp>
 
#include <cstdint>
 
namespace ML {
 
using solver    = raft::linalg::solver;
using mg_solver = raft::linalg::solver;
 
class params {
 public:
  std::size_t n_rows;
  std::size_t n_cols;
  int gpu_id = 0;
};
 
class paramsSolver : public params {
 public:
  // math_t tol = 0.0;
  float tol                  = 0.0;
  std::uint32_t n_iterations = 15;
  int verbose                = 0;
};
 
template <typename enum_solver = solver>
class paramsTSVDTemplate : public paramsSolver {
 public:
  std::size_t n_components = 1;
  enum_solver algorithm    = enum_solver::COV_EIG_DQ;
};
 
template <typename enum_solver = solver>
class paramsPCATemplate : public paramsTSVDTemplate<enum_solver> {
 public:
  bool copy   = true;  // TODO unused, see #2830 and #2833
  bool whiten = false;
};
 
typedef paramsTSVDTemplate<> paramsTSVD;
typedef paramsPCATemplate<> paramsPCA;
 
typedef paramsPCATemplate<mg_solver> paramsPCAMG;
typedef paramsTSVDTemplate<mg_solver> paramsTSVDMG;
 
template <typename enum_solver>
inline raft::linalg::paramsTSVD to_raft_params(const paramsTSVDTemplate<enum_solver>& ml_prms)
{
  raft::linalg::paramsTSVD prms;
  prms.tol          = ml_prms.tol;
  prms.n_iterations = ml_prms.n_iterations;
  prms.algorithm    = ml_prms.algorithm;
  return prms;
}
 
template <typename enum_solver>
inline raft::linalg::paramsPCA to_raft_params(const paramsPCATemplate<enum_solver>& ml_prms)
{
  raft::linalg::paramsPCA prms;
  prms.tol          = ml_prms.tol;
  prms.n_iterations = ml_prms.n_iterations;
  prms.algorithm    = ml_prms.algorithm;
  prms.copy         = ml_prms.copy;
  prms.whiten       = ml_prms.whiten;
  return prms;
}
 
};  // end namespace ML