QuantLib: a free/open-source library for quantitative finance
fully annotated source code - version 1.34
Loading...
Searching...
No Matches
fdmlinearopcomposite.hpp
Go to the documentation of this file.
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2
3/*
4 Copyright (C) 2008 Andreas Gaida
5 Copyright (C) 2008 Ralph Schreyer
6 Copyright (C) 2008, 2012 Klaus Spanderen
7
8 This file is part of QuantLib, a free-software/open-source library
9 for financial quantitative analysts and developers - http://quantlib.org/
10
11 QuantLib is free software: you can redistribute it and/or modify it
12 under the terms of the QuantLib license. You should have received a
13 copy of the license along with this program; if not, please email
14 <quantlib-dev@lists.sf.net>. The license is also available online at
15 <http://quantlib.org/license.shtml>.
16
17 This program is distributed in the hope that it will be useful, but WITHOUT
18 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
19 FOR A PARTICULAR PURPOSE. See the license for more details.
20*/
21
22/*! \file fdmlinearopcomposite.hpp
23 \brief composite pattern for linear operators
24*/
25
26#ifndef quantlib_fdm_affine_map_composite_hpp
27#define quantlib_fdm_affine_map_composite_hpp
28
31#include <numeric>
32
33namespace QuantLib {
34
36 public:
37 virtual Size size() const = 0;
38
39 //! Time \f$t1 <= t2\f$ is required
40 virtual void setTime(Time t1, Time t2) = 0;
41
42 virtual Array apply_mixed(const Array& r) const = 0;
43
44 virtual Array apply_direction(Size direction, const Array& r) const = 0;
45 virtual Array solve_splitting(Size direction, const Array& r, Real s) const = 0;
46 virtual Array preconditioner(const Array& r, Real s) const = 0;
47
48 virtual std::vector<SparseMatrix> toMatrixDecomp() const {
49 QL_FAIL(" ublas representation is not implemented");
50 }
51
52 SparseMatrix toMatrix() const override {
53 const std::vector<SparseMatrix> dcmp = toMatrixDecomp();
54 return std::accumulate(dcmp.begin()+1, dcmp.end(),
55 SparseMatrix(dcmp.front()));
56 }
57
58 };
59}
60
61#endif
1-D array used in linear algebra.
Definition: array.hpp:52
virtual Size size() const =0
virtual std::vector< SparseMatrix > toMatrixDecomp() const
SparseMatrix toMatrix() const override
virtual void setTime(Time t1, Time t2)=0
Time is required.
virtual Array preconditioner(const Array &r, Real s) const =0
virtual Array apply_mixed(const Array &r) const =0
virtual Array solve_splitting(Size direction, const Array &r, Real s) const =0
virtual Array apply_direction(Size direction, const Array &r) const =0
#define QL_FAIL(message)
throw an error (possibly with file and line information)
Definition: errors.hpp:92
linear operator to model a multi dimensinal pde system
Real Time
continuous quantity with 1-year units
Definition: types.hpp:62
QL_REAL Real
real number
Definition: types.hpp:50
std::size_t Size
size of a container
Definition: types.hpp:58
Definition: any.hpp:35
boost::numeric::ublas::compressed_matrix< Real > SparseMatrix
ext::shared_ptr< YieldTermStructure > r
typedef for boost sparse matrix class