latest/doxygen/Cholesky_8hpp_source.html

// Copyright (c) 2021 Graphcore Ltd. All rights reserved.

#ifndef poplin_Cholesky_hpp

#define poplin_Cholesky_hpp

#include "poplin/MatMul.hpp"

#include <poplar/Graph.hpp>

#include <poplar/Program.hpp>


namespace poplin {


class PlanningCache;


std::vector<std::pair<MatMulParams, poplar::OptionFlags>>

getCholeskyMatMulPrePlanParameters(const poplar::Type &type,

                                   const std::vector<std::size_t> &shape,

                                   bool lower, poplar::OptionFlags options);


poplar::Tensor createCholeskyInput(poplar::Graph &graph,

                                   const poplar::Type &type,

                                   const std::vector<std::size_t> &shape,

                                   bool lower,

                                   const poplar::DebugContext &debugContext,

                                   const poplar::OptionFlags &options = {},

                                   PlanningCache *cache = nullptr);


poplar::Tensor cholesky(poplar::Graph &graph, const poplar::Tensor &a,

                        bool lower, poplar::program::Sequence &prog,

                        const poplar::DebugContext &debugContext = {},

                        poplar::OptionFlags options = {},

                        PlanningCache *cache = nullptr);


void choleskyInPlace(poplar::Graph &graph, const poplar::Tensor &a, bool lower,

                     poplar::program::Sequence &prog,

                     const poplar::DebugContext &debugContext = {},

                     poplar::OptionFlags options = {},

                     PlanningCache *cache = nullptr);


} // namespace poplin


#endif // poplin_Cholesky_hpp

poplar::DebugContext
DebugContext gathers the common external parameters of the context of an operation.
Definition: DebugContext.hpp:221

poplar::Graph
This class represents a graph program to be executed on the IPU.
Definition: Graph.hpp:52

poplar::OptionFlags
A set of option/value string flags to be used in various APIs.
Definition: OptionFlags.hpp:24

poplar::Tensor
A reference to a subset of tensor elements.
Definition: Tensor.hpp:38

poplar::Type
Class representing device data types.
Definition: Type.hpp:42

poplar::program::Sequence
Program that executes a sequence of programs.
Definition: Program.hpp:77

poplin
Linear algebra functions.
Definition: Cholesky.hpp:14

poplin::cholesky
poplar::Tensor cholesky(poplar::Graph &graph, const poplar::Tensor &a, bool lower, poplar::program::Sequence &prog, const poplar::DebugContext &debugContext={}, poplar::OptionFlags options={}, PlanningCache *cache=nullptr)
Computes Cholesky factor for a symmetric positive definite matrix.

poplin::choleskyInPlace
void choleskyInPlace(poplar::Graph &graph, const poplar::Tensor &a, bool lower, poplar::program::Sequence &prog, const poplar::DebugContext &debugContext={}, poplar::OptionFlags options={}, PlanningCache *cache=nullptr)
Computes Cholesky factor in place for a symmetric positive definite matrix.

poplin::getCholeskyMatMulPrePlanParameters
std::vector< std::pair< MatMulParams, poplar::OptionFlags > > getCholeskyMatMulPrePlanParameters(const poplar::Type &type, const std::vector< std::size_t > &shape, bool lower, poplar::OptionFlags options)
Plan matrix multiplication for the Cholesky factoriser.

poplin::createCholeskyInput
poplar::Tensor createCholeskyInput(poplar::Graph &graph, const poplar::Type &type, const std::vector< std::size_t > &shape, bool lower, const poplar::DebugContext &debugContext, const poplar::OptionFlags &options={}, PlanningCache *cache=nullptr)
Create a tensor that is used as the input for the Cholesky factoriser.

MatMul.hpp
Functions and data types for performing matrix multiplies on the IPU.