CoDiPack  2.2.0
A Code Differentiation Package
SciComp TU Kaiserslautern
Loading...
Searching...
No Matches
hessianInterface.hpp
1/*
2 * CoDiPack, a Code Differentiation Package
3 *
4 * Copyright (C) 2015-2024 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
5 * Homepage: http://scicomp.rptu.de
6 * Contact: Prof. Nicolas R. Gauger (codi@scicomp.uni-kl.de)
7 *
8 * Lead developers: Max Sagebaum, Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
9 *
10 * This file is part of CoDiPack (http://scicomp.rptu.de/software/codi).
11 *
12 * CoDiPack is free software: you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, either version 3 of the
15 * License, or (at your option) any later version.
16 *
17 * CoDiPack is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty
19 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
20 *
21 * See the GNU General Public License for more details.
22 * You should have received a copy of the GNU
23 * General Public License along with CoDiPack.
24 * If not, see <http://www.gnu.org/licenses/>.
25 *
26 * For other licensing options please contact us.
27 *
28 * Authors:
29 * - SciComp, University of Kaiserslautern-Landau:
30 * - Max Sagebaum
31 * - Johannes Blühdorn
32 * - Former members:
33 * - Tim Albring
34 */
35#pragma once
36
37#include <vector>
38
39#include "../../misc/macros.hpp"
40
42namespace codi {
43
63 template<typename T_T>
65 public:
66
67 using T = CODI_DD(T_T, double);
68
69 virtual ~HessianInterface() {}
70
71 size_t getM() const;
72 size_t getN() const;
73
81 T operator()(size_t const i, size_t const j, size_t const k) const;
82
88 T& operator()(size_t const i, size_t const j, size_t const k);
89
90 void resize(size_t const m, size_t const n);
91 size_t size() const;
92 };
93}
#define CODI_DD(Type, Default)
Abbreviation for CODI_DECLARE_DEFAULT.
Definition macros.hpp:94
CoDiPack - Code Differentiation Package.
Definition codi.hpp:90
General interface for Hessian access in CoDiPack.
Definition hessianInterface.hpp:64
T & operator()(size_t const i, size_t const j, size_t const k)
Reference access.
size_t getM() const
Get size of rows (output variables).
virtual ~HessianInterface()
Destructor.
Definition hessianInterface.hpp:69
T operator()(size_t const i, size_t const j, size_t const k) const
Value access.
T_T T
See HessianInterface.
Definition hessianInterface.hpp:67
void resize(size_t const m, size_t const n)
Resize to the new dimensions.
size_t getN() const
Get size of columns (input variables).
size_t size() const
Get total size of the Hessian.