params.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2022, NVIDIA CORPORATION.
 *
 * 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.
 */
 
#pragma once
 
#include <cstdint>
 
namespace ML {
 
enum class solver : int {
  COV_EIG_DQ,
  COV_EIG_JACOBI,
};
 
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;
 
enum class mg_solver { COV_EIG_DQ, COV_EIG_JACOBI, QR };
 
typedef paramsPCATemplate<mg_solver> paramsPCAMG;
typedef paramsTSVDTemplate<mg_solver> paramsTSVDMG;
 
};  // end namespace ML