latest/doxygen/TriangularSolve_8hpp_source.html

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

#ifndef poplin_TriangularSolve_hpp

#define poplin_TriangularSolve_hpp

#include <poplar/Graph.hpp>

#include <poplar/Program.hpp>

#include <poplin/MatMul.hpp>


namespace poplin {


poplar::Tensor createTriangularSolveInputLHS(

    poplar::Graph &graph, const poplar::Type &inputType,

    const poplar::Type &outputType, const std::vector<std::size_t> &aShape,

    const std::vector<std::size_t> &bShape, bool leftSide,

    const poplar::DebugContext &debugContext,

    const poplar::OptionFlags &options = {}, PlanningCache *cache = nullptr);


poplar::Tensor createTriangularSolveInputRHS(

    poplar::Graph &graph, const poplar::Type &inputType,

    const poplar::Type &outputType, const std::vector<std::size_t> &aShape,

    const std::vector<std::size_t> &bShape, bool leftSide,

    const poplar::DebugContext &debugContext,

    const poplar::OptionFlags &options = {}, PlanningCache *cache = nullptr);


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

                              bool lower, bool unitDiagonal,

                              poplar::program::Sequence &prog,

                              const poplar::DebugContext &debugContext = {});


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

                               const poplar::Tensor &b, bool leftSide,

                               bool lower, bool unitDiagonal,

                               poplar::program::Sequence &prog,

                               const poplar::DebugContext &debugContext = {},

                               const poplar::OptionFlags &options = {},

                               PlanningCache *cache = nullptr);


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

getTriangularSolveMatMulPrePlanParameters(

    const poplar::Type &inputType, const poplar::Type &outputType,

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

    const std::vector<std::size_t> &bShape, bool leftSide, bool lower,

    const poplar::OptionFlags &options);


} // namespace poplin


#endif // poplin_TriangularSolve_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::createTriangularSolveInputRHS
poplar::Tensor createTriangularSolveInputRHS(poplar::Graph &graph, const poplar::Type &inputType, const poplar::Type &outputType, const std::vector< std::size_t > &aShape, const std::vector< std::size_t > &bShape, bool leftSide, const poplar::DebugContext &debugContext, const poplar::OptionFlags &options={}, PlanningCache *cache=nullptr)
Create a tensor that is used as the right operand of triangular solve.

poplin::createTriangularSolveInputLHS
poplar::Tensor createTriangularSolveInputLHS(poplar::Graph &graph, const poplar::Type &inputType, const poplar::Type &outputType, const std::vector< std::size_t > &aShape, const std::vector< std::size_t > &bShape, bool leftSide, const poplar::DebugContext &debugContext, const poplar::OptionFlags &options={}, PlanningCache *cache=nullptr)
Create a tensor that is used as the left operand of triangular solve.

poplin::triangularMask
poplar::Tensor triangularMask(poplar::Graph &graph, const poplar::Tensor &a, bool lower, bool unitDiagonal, poplar::program::Sequence &prog, const poplar::DebugContext &debugContext={})
Masks the unused components of the input tensor with zeroes, optionally allowing for a unit diagonal.

poplin::getTriangularSolveMatMulPrePlanParameters
std::vector< std::pair< MatMulParams, poplar::OptionFlags > > getTriangularSolveMatMulPrePlanParameters(const poplar::Type &inputType, const poplar::Type &outputType, const std::vector< std::size_t > &aShape, const std::vector< std::size_t > &bShape, bool leftSide, bool lower, const poplar::OptionFlags &options)
Plan matrix multiplication for given triangular solver.

poplin::triangularSolve
poplar::Tensor triangularSolve(poplar::Graph &graph, const poplar::Tensor &a, const poplar::Tensor &b, bool leftSide, bool lower, bool unitDiagonal, poplar::program::Sequence &prog, const poplar::DebugContext &debugContext={}, const poplar::OptionFlags &options={}, PlanningCache *cache=nullptr)
Solves systems of linear equations with lower or upper triangular coefficients.

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