/usr/include/trilinos/Sacado_Fad_SFad_MP_Vector.hpp is in libtrilinos-stokhos-dev 12.10.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 | // @HEADER
// ***********************************************************************
//
// Sacado Package
// Copyright (2006) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
// (etphipp@sandia.gov).
//
// ***********************************************************************
//
// The forward-mode AD classes in Sacado are a derivative work of the
// expression template classes in the Fad package by Nicolas Di Cesare.
// The following banner is included in the original Fad source code:
//
// ************ DO NOT REMOVE THIS BANNER ****************
//
// Nicolas Di Cesare <Nicolas.Dicesare@ann.jussieu.fr>
// http://www.ann.jussieu.fr/~dicesare
//
// CEMRACS 98 : C++ courses,
// templates : new C++ techniques
// for scientific computing
//
//********************************************************
//
// A short implementation ( not all operators and
// functions are overloaded ) of 1st order Automatic
// Differentiation in forward mode (FAD) using
// EXPRESSION TEMPLATES.
//
//********************************************************
// @HEADER
#ifndef SACADO_FAD_SFAD_MP_VECTOR_HPP
#define SACADO_FAD_SFAD_MP_VECTOR_HPP
#include "Sacado_Fad_SFad.hpp"
#include "Sacado_Fad_ExprSpec_MP_Vector.hpp"
namespace Stokhos {
template <typename Ord, typename Val, int Num, typename Dev>
class StaticFixedStorage;
}
namespace Sacado {
namespace MP {
template <typename S> class Vector;
}
namespace Fad {
template <typename Ord, typename Val, int VecNum, typename Dev, int Num>
struct ExprSpec< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage<Ord,Val,VecNum,Dev> >, Num > > {
typedef ExprSpecMPVector type;
};
template <typename Ord, typename Val, int VecNum, typename Dev, int Num>
struct ExprSpec< SFad< Sacado::MP::Vector< Stokhos::StaticFixedStorage<Ord,Val,VecNum,Dev> >, Num > > {
typedef ExprSpecMPVector type;
};
/*!
* \brief Expression template forward-mode AD class with static memory
* allocation.
*/
/*!
* This classes specializes Expr to SFad expressions.
*/
template <typename Ord, typename Val, int VecNum, typename Dev, int Num>
class Expr< SFadExprTag< Sacado::MP::Vector< Stokhos::StaticFixedStorage<Ord,Val,VecNum,Dev> >,Num >,ExprSpecMPVector > {
public:
typedef Sacado::MP::Vector< Stokhos::StaticFixedStorage<Ord,Val,VecNum,Dev> > T;
//! Typename of values
typedef typename RemoveConst<T>::type value_type;
//! Typename of scalar's (which may be different from T)
typedef typename ScalarType<value_type>::type scalar_type;
//! Typename of base-expressions
typedef SFad<value_type,Num> base_expr_type;
typedef typename value_type::value_type val_type;
/*!
* @name Initialization methods
*/
//@{
//! Default constructor
KOKKOS_INLINE_FUNCTION
Expr() : val_( T(0.)) {
ss_array<T>::zero(dx_, Num); }
//! Constructor with supplied value \c x
/*!
* Initializes value to \c x and derivative array is empty
*/
template <typename S>
KOKKOS_INLINE_FUNCTION
Expr(const S & x, SACADO_ENABLE_VALUE_CTOR_DECL) :
val_(x) {
ss_array<T>::zero(dx_, Num);
}
//! Constructor with size \c sz and value \c x
/*!
* Initializes value to \c x and derivative array 0 of length \c sz
*/
KOKKOS_INLINE_FUNCTION
Expr(const int sz, const T & x, const DerivInit zero_out = InitDerivArray) : val_(x) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ )
if (sz != Num)
throw "SFad::SFad() Error: Supplied derivative dimension does not match compile time length.";
#endif
if (zero_out == InitDerivArray)
ss_array<T>::zero(dx_, Num);
}
//! Constructor with size \c sz, index \c i, and value \c x
/*!
* Initializes value to \c x and derivative array of length \c sz
* as row \c i of the identity matrix, i.e., sets derivative component
* \c i to 1 and all other's to zero.
*/
KOKKOS_INLINE_FUNCTION
Expr(const int sz, const int i, const T & x) :
val_(x) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ )
if (sz != Num)
throw "SFad::SFad() Error: Supplied derivative dimension does not match compile time length.";
if (i >= Num)
throw "SFad::SFad() Error: Invalid derivative index.";
#endif
ss_array<T>::zero(dx_, Num);
dx_[i]=1.;
}
//! Copy constructor
KOKKOS_INLINE_FUNCTION
Expr(const Expr& x) :
val_(x.val()) {
for (int i=0; i<Num; i++)
dx_[i] = x.dx_[i];
}
//! Copy constructor from any Expression object
template <typename S>
KOKKOS_INLINE_FUNCTION
Expr(const Expr<S>& x, SACADO_ENABLE_EXPR_CTOR_DECL) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ )
if (x.size() != Num)
throw "SFad::SFad() Error: Attempt to assign with incompatible sizes";
#endif
for(int i=0; i<Num; ++i) {
for (int j=0; j<VecNum; ++j)
dx_[i].fastAccessCoeff(j) = x.fastAccessDx(i,j);
}
for (int j=0; j<VecNum; ++j)
this->val(j) = x.val(j);
}
//! Destructor
KOKKOS_INLINE_FUNCTION
~Expr() {}
//! Set %Fad object as the \c ith independent variable
/*!
* Sets the derivative array of length \c n to the \c ith row of the
* identity matrix and has the same affect as the
* Implementation(const int sz, const int i, const T & x)
* constructor.
*/
KOKKOS_INLINE_FUNCTION
void diff(const int ith, const int n) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ )
if (n != Num)
throw "SFad::diff() Error: Supplied derivative dimension does not match compile time length.";
#endif
ss_array<T>::zero(dx_, Num);
dx_[ith] = T(1.);
}
//! Resize derivative array to length \c sz
/*!
* Since the derivative array length is not dynamic, this method
* throws an error if compiled with SACADO_DEBUG defined.
*/
KOKKOS_INLINE_FUNCTION
void resize(int sz) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ )
if (sz != Num)
throw "SFad::resize() Error: Cannot resize fixed derivative array dimension";
#endif
}
//! Expand derivative array to size sz
/*!
* Since the derivative array length is not dynamic, this method
* throws an error if compiled with SACADO_DEBUG defined.
*/
KOKKOS_INLINE_FUNCTION
void expand(int sz) { resize(sz); }
//! Zero out the derivative array
KOKKOS_INLINE_FUNCTION
void zero() { ss_array<T>::zero(dx_, Num); }
//! Set whether this Fad object should update values
KOKKOS_INLINE_FUNCTION
void setUpdateValue(bool update_val) { }
//! Return whether this Fad object has an updated value
KOKKOS_INLINE_FUNCTION
bool updateValue() const { return true; }
//! Returns whether two Fad objects have the same values
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_EXPR_FUNC(bool) isEqualTo(const Expr<S>& x) const {
typedef IsEqual<value_type> IE;
if (x.size() != this->size()) return false;
bool eq = IE::eval(x.val(), this->val());
for (int i=0; i<this->size(); i++)
eq = eq && IE::eval(x.dx(i), this->dx(i));
return eq;
}
//@}
/*!
* @name Value accessor methods
*/
//@{
//! Returns value
KOKKOS_INLINE_FUNCTION
const T& val() const { return val_;}
//! Returns value
KOKKOS_INLINE_FUNCTION
T& val() { return val_;}
//! Returns value
KOKKOS_INLINE_FUNCTION
const val_type& val(int j) const { return val_.fastAccessCoeff(j);}
//! Returns value
KOKKOS_INLINE_FUNCTION
val_type& val(int j) { return val_.fastAccessCoeff(j);}
//@}
/*!
* @name Derivative accessor methods
*/
//@{
//! Returns number of derivative components
KOKKOS_INLINE_FUNCTION
int size() const { return Num;}
/*!
* \brief Returns number of derivative components that can be stored
* without reallocation
*/
KOKKOS_INLINE_FUNCTION
int availableSize() const { return Num; }
//! Returns true if derivative array is not empty
KOKKOS_INLINE_FUNCTION
bool hasFastAccess() const { return true; }
//! Returns true if derivative array is empty
KOKKOS_INLINE_FUNCTION
bool isPassive() const { return false; }
//! Set whether variable is constant
KOKKOS_INLINE_FUNCTION
void setIsConstant(bool is_const) {}
//! Returns derivative array
KOKKOS_INLINE_FUNCTION
const T* dx() const { return &(dx_[0]);}
//! Returns derivative component \c i with bounds checking
KOKKOS_INLINE_FUNCTION
const T& dx(int i) const { return dx_[i]; }
//! Returns derivative component \c i without bounds checking
KOKKOS_INLINE_FUNCTION
T& fastAccessDx(int i) { return dx_[i];}
//! Returns derivative component \c i without bounds checking
KOKKOS_INLINE_FUNCTION
const T& fastAccessDx(int i) const { return dx_[i];}
//! Returns derivative component \c i with bounds checking
KOKKOS_INLINE_FUNCTION
const val_type& dx(int i, int j) const { return dx_[i].fastAccessCoeff(j); }
//! Returns derivative component \c i without bounds checking
KOKKOS_INLINE_FUNCTION
val_type& fastAccessDx(int i, int j) { return dx_[i].fastAccessCoeff(j);}
//! Returns derivative component \c i without bounds checking
KOKKOS_INLINE_FUNCTION
const val_type& fastAccessDx(int i, int j) const { return dx_[i].fastAccessCoeff(j);}
//@}
/*!
* @name Assignment operators
*/
//@{
//! Assignment operator with constant right-hand-side
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_VALUE_FUNC(Expr&) operator=(const S& v) {
val_ = v;
ss_array<T>::zero(dx_, Num);
return *this;
}
//! Assignment with Expr right-hand-side
KOKKOS_INLINE_FUNCTION
Expr& operator=(const Expr& x) {
if (this != &x) {
// Copy value
val_ = x.val_;
// Copy dx_
for (int i=0; i<Num; i++)
dx_[i] = x.dx_[i];
}
return *this;
}
//! Assignment operator with any expression right-hand-side
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_EXPR_FUNC(Expr&) operator=(const Expr<S>& x) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ )
if (x.size() != Num)
throw "SFad::operator=() Error: Attempt to assign with incompatible sizes";
#endif
for(int i=0; i<Num; ++i) {
for (int j=0; j<VecNum; ++j)
dx_[i].fastAccessCoeff(j) = x.fastAccessDx(i,j);
}
for (int j=0; j<VecNum; ++j)
this->val(j) = x.val(j);
return *this;
}
//@}
/*!
* @name Unary operators
*/
//@{
//! Addition-assignment operator with constant right-hand-side
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_VALUE_FUNC(Expr&) operator += (const S& v) {
this->val() += v;
return *this;
}
//! Subtraction-assignment operator with constant right-hand-side
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_VALUE_FUNC(Expr&) operator -= (const S& v) {
this->val() -= v;
return *this;
}
//! Multiplication-assignment operator with constant right-hand-side
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_VALUE_FUNC(Expr&) operator *= (const S& v) {
this->val() *= v;
for (int i=0; i<Num; ++i)
dx_[i] *= v;
return *this;
}
//! Division-assignment operator with constant right-hand-side
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_VALUE_FUNC(Expr&) operator /= (const S& v) {
this->val() /= v;
for (int i=0; i<Num; ++i)
dx_[i] /= v;
return *this;
}
//! Addition-assignment operator with Expr right-hand-side
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_EXPR_FUNC(Expr&) operator += (const Expr<S>& x) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ )
if (x.size() != Num)
throw "SFad::operator+=() Error: Attempt to assign with incompatible sizes";
#endif
for(int i=0; i<Num; ++i) {
for (int j=0; j<VecNum; ++j)
dx_[i].fastAccessCoeff(j) += x.fastAccessDx(i,j);
}
for (int j=0; j<VecNum; ++j)
this->val(j) += x.val(j);
return *this;
}
//! Subtraction-assignment operator with Expr right-hand-side
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_EXPR_FUNC(Expr&) operator -= (const Expr<S>& x) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ )
if (x.size() != Num)
throw "SFad::operator-=() Error: Attempt to assign with incompatible sizes";
#endif
for(int i=0; i<Num; ++i) {
for (int j=0; j<VecNum; ++j)
dx_[i].fastAccessCoeff(j) -= x.fastAccessDx(i,j);
}
for (int j=0; j<VecNum; ++j)
this->val(j) -= x.val(j);
return *this;
}
//! Multiplication-assignment operator with Expr right-hand-side
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_EXPR_FUNC(Expr&) operator *= (const Expr<S>& x) {
T xval;
for (int j=0; j<VecNum; ++j)
xval.fastAccessCoeff(j) = x.val(j);
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ )
if (x.size() != Num)
throw "SFad::operator*=() Error: Attempt to assign with incompatible sizes";
#endif
for(int i=0; i<Num; ++i)
for (int j=0; j<VecNum; ++j)
dx_[i].fastAccessCoeff(j) = val_.fastAccessCoeff(j) * x.fastAccessDx(i,j) + dx_[i] * xval.fastAccessCoeff(j);
val_ *= xval;
return *this;
}
//! Division-assignment operator with Expr right-hand-side
template <typename S>
KOKKOS_INLINE_FUNCTION
SACADO_ENABLE_EXPR_FUNC(Expr&) operator /= (const Expr<S>& x) {
T xval;
for (int j=0; j<VecNum; ++j)
xval.fastAccessCoeff(j) = x.val(j);
T xval2 = xval*xval;
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ )
if (x.size() != Num)
throw "SFad::operator/=() Error: Attempt to assign with incompatible sizes";
#endif
for(int i=0; i<Num; ++i)
for (int j=0; j<VecNum; ++j)
dx_[i].fastAccessCoeff(j) = ( dx_[i].fastAccessCoeff(j)*xval.fastAccessCoeff(j) - val_.fastAccessCoeff(j)*x.fastAccessDx(i,j) )/ (xval2.fastAccessCoeff(j));
val_ /= xval;
return *this;
}
//@}
protected:
//! Derivatives
T dx_[Num];
//! Value
T val_;
}; // class Expr<SFadExprTag>
} // namespace Fad
} // namespace Sacado
#include "Sacado_Fad_Ops_MP_Vector.hpp"
#endif // SACADO_FAD_SFAD_MP_VECTOR_HPP
|