All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TSMatDMatSubExpr.h
Go to the documentation of this file.
1 //=================================================================================================
33 //=================================================================================================
34 
35 #ifndef _BLAZE_MATH_EXPRESSIONS_TSMATDMATSUBEXPR_H_
36 #define _BLAZE_MATH_EXPRESSIONS_TSMATDMATSUBEXPR_H_
37 
38 
39 //*************************************************************************************************
40 // Includes
41 //*************************************************************************************************
42 
43 #include <stdexcept>
61 #include <blaze/util/Assert.h>
64 #include <blaze/util/SelectType.h>
65 #include <blaze/util/Types.h>
66 
67 
68 namespace blaze {
69 
70 //=================================================================================================
71 //
72 // CLASS SMATTDMATSUBEXPR
73 //
74 //=================================================================================================
75 
76 //*************************************************************************************************
83 template< typename MT1 // Type of the left-hand side sparse matrix
84  , typename MT2 > // Type of the right-hand side dense matrix
85 class TSMatDMatSubExpr : public DenseMatrix< TSMatDMatSubExpr<MT1,MT2>, false >
86  , private MatMatSubExpr
87  , private Computation
88 {
89  private:
90  //**Type definitions****************************************************************************
91  typedef typename MT1::ResultType RT1;
92  typedef typename MT2::ResultType RT2;
93  typedef typename MT1::ReturnType RN1;
94  typedef typename MT2::ReturnType RN2;
95  //**********************************************************************************************
96 
97  //**Return type evaluation**********************************************************************
99 
104  enum { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value };
105 
108  //**********************************************************************************************
109 
110  public:
111  //**Type definitions****************************************************************************
117 
120 
122  typedef const ResultType CompositeType;
123 
125  typedef typename SelectType< IsExpression<MT1>::value, const MT1, const MT1& >::Type LeftOperand;
126 
128  typedef typename SelectType< IsExpression<MT2>::value, const MT2, const MT2& >::Type RightOperand;
129  //**********************************************************************************************
130 
131  //**Compilation flags***************************************************************************
133  enum { vectorizable = 0 };
134 
136  enum { smpAssignable = 0 };
137  //**********************************************************************************************
138 
139  //**Constructor*********************************************************************************
145  explicit inline TSMatDMatSubExpr( const MT1& lhs, const MT2& rhs )
146  : lhs_( lhs ) // Left-hand side sparse matrix of the subtraction expression
147  , rhs_( rhs ) // Right-hand side dense matrix of the subtraction expression
148  {
149  BLAZE_INTERNAL_ASSERT( lhs.rows() == rhs.rows() , "Invalid number of rows" );
150  BLAZE_INTERNAL_ASSERT( lhs.columns() == rhs.columns(), "Invalid number of columns" );
151  }
152  //**********************************************************************************************
153 
154  //**Access operator*****************************************************************************
161  inline ReturnType operator()( size_t i, size_t j ) const {
162  BLAZE_INTERNAL_ASSERT( i < lhs_.rows() , "Invalid row access index" );
163  BLAZE_INTERNAL_ASSERT( j < lhs_.columns(), "Invalid column access index" );
164  return lhs_(i,j) - rhs_(i,j);
165  }
166  //**********************************************************************************************
167 
168  //**Rows function*******************************************************************************
173  inline size_t rows() const {
174  return lhs_.rows();
175  }
176  //**********************************************************************************************
177 
178  //**Columns function****************************************************************************
183  inline size_t columns() const {
184  return lhs_.columns();
185  }
186  //**********************************************************************************************
187 
188  //**Left operand access*************************************************************************
193  inline LeftOperand leftOperand() const {
194  return lhs_;
195  }
196  //**********************************************************************************************
197 
198  //**Right operand access************************************************************************
203  inline RightOperand rightOperand() const {
204  return rhs_;
205  }
206  //**********************************************************************************************
207 
208  //**********************************************************************************************
214  template< typename T >
215  inline bool canAlias( const T* alias ) const {
216  return ( lhs_.canAlias( alias ) ) ||
217  ( IsExpression<MT2>::value && rhs_.canAlias( alias ) );
218  }
219  //**********************************************************************************************
220 
221  //**********************************************************************************************
227  template< typename T >
228  inline bool isAliased( const T* alias ) const {
229  return lhs_.isAliased( alias ) || rhs_.isAliased( alias );
230  }
231  //**********************************************************************************************
232 
233  private:
234  //**Member variables****************************************************************************
237  //**********************************************************************************************
238 
239  //**Assignment to dense matrices****************************************************************
251  template< typename MT // Type of the target dense matrix
252  , bool SO2 > // Storage order of the target dense matrix
253  friend inline void assign( DenseMatrix<MT,SO2>& lhs, const TSMatDMatSubExpr& rhs )
254  {
256 
257  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
258  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
259 
260  smpAssign ( ~lhs, -rhs.rhs_ );
261  smpAddAssign( ~lhs, rhs.lhs_ );
262  }
264  //**********************************************************************************************
265 
266  //**Assignment to sparse matrices***************************************************************
278  template< typename MT // Type of the target sparse matrix
279  , bool SO2 > // Storage order of the target sparse matrix
280  friend inline void assign( SparseMatrix<MT,SO2>& lhs, const TSMatDMatSubExpr& rhs )
281  {
283 
284  typedef typename SelectType< SO2, OppositeType, ResultType >::Type TmpType;
285 
292 
293  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
294  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
295 
296  const TmpType tmp( rhs );
297  smpAssign( ~lhs, tmp );
298  }
300  //**********************************************************************************************
301 
302  //**Addition assignment to dense matrices*******************************************************
315  template< typename MT // Type of the target dense matrix
316  , bool SO2 > // Storage order of the target dense matrix
317  friend inline void addAssign( DenseMatrix<MT,SO2>& lhs, const TSMatDMatSubExpr& rhs )
318  {
320 
321  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
322  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
323 
324  smpSubAssign( ~lhs, rhs.rhs_ );
325  smpAddAssign( ~lhs, rhs.lhs_ );
326  }
328  //**********************************************************************************************
329 
330  //**Addition assignment to sparse matrices******************************************************
331  // No special implementation for the addition assignment to sparse matrices.
332  //**********************************************************************************************
333 
334  //**Subtraction assignment to dense matrices****************************************************
347  template< typename MT // Type of the target dense matrix
348  , bool SO2 > // Storage order of the target dense matrix
349  friend inline void subAssign( DenseMatrix<MT,SO2>& lhs, const TSMatDMatSubExpr& rhs )
350  {
352 
353  BLAZE_INTERNAL_ASSERT( (~lhs).rows() == rhs.rows() , "Invalid number of rows" );
354  BLAZE_INTERNAL_ASSERT( (~lhs).columns() == rhs.columns(), "Invalid number of columns" );
355 
356  smpAddAssign( ~lhs, rhs.rhs_ );
357  smpSubAssign( ~lhs, rhs.lhs_ );
358  }
360  //**********************************************************************************************
361 
362  //**Subtraction assignment to sparse matrices***************************************************
363  // No special implementation for the subtraction assignment to sparse matrices.
364  //**********************************************************************************************
365 
366  //**Multiplication assignment to dense matrices*************************************************
367  // No special implementation for the multiplication assignment to dense matrices.
368  //**********************************************************************************************
369 
370  //**Multiplication assignment to sparse matrices************************************************
371  // No special implementation for the multiplication assignment to sparse matrices.
372  //**********************************************************************************************
373 
374  //**Compile time checks*************************************************************************
381  //**********************************************************************************************
382 };
383 //*************************************************************************************************
384 
385 
386 
387 
388 //=================================================================================================
389 //
390 // GLOBAL BINARY ARITHMETIC OPERATORS
391 //
392 //=================================================================================================
393 
394 //*************************************************************************************************
424 template< typename T1 // Type of the left-hand side sparse matrix
425  , typename T2 > // Type of the right-hand side dense matrix
426 inline const TSMatDMatSubExpr<T1,T2>
428 {
430 
431  if( (~lhs).rows() != (~rhs).rows() || (~lhs).columns() != (~rhs).columns() )
432  throw std::invalid_argument( "Matrix sizes do not match" );
433 
434  return TSMatDMatSubExpr<T1,T2>( ~lhs, ~rhs );
435 }
436 //*************************************************************************************************
437 
438 
439 
440 
441 //=================================================================================================
442 //
443 // GLOBAL RESTRUCTURING BINARY ARITHMETIC OPERATORS
444 //
445 //=================================================================================================
446 
447 //*************************************************************************************************
460 template< typename T1 // Type of the sparse matrix of the left-hand side expression
461  , typename T2 // Type of the dense matrix of the left-hand side expression
462  , typename T3 // Type of the right-hand side dense matrix
463  , bool SO > // Storage order of the right-hand side dense matrix
464 inline const typename AddExprTrait< TSMatDMatSubExpr<T1,T2>, T3 >::Type
465  operator+( const TSMatDMatSubExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
466 {
468 
469  return ( (~rhs) - lhs.rightOperand() ) + lhs.leftOperand();
470 }
472 //*************************************************************************************************
473 
474 
475 //*************************************************************************************************
488 template< typename T1 // Type of the sparse matrix of the left-hand side expression
489  , typename T2 // Type of the dense matrix of the left-hand side expression
490  , typename T3 // Type of the right-hand side dense matrix
491  , bool SO > // Storage order of the right-hand side dense matrix
492 inline const typename SubExprTrait< TSMatDMatSubExpr<T1,T2>, T3 >::Type
493  operator-( const TSMatDMatSubExpr<T1,T2>& lhs, const DenseMatrix<T3,SO>& rhs )
494 {
496 
497  return lhs.leftOperand() - ( lhs.rightOperand() + (~rhs) );
498 }
500 //*************************************************************************************************
501 
502 
503 
504 
505 //=================================================================================================
506 //
507 // EXPRESSION TRAIT SPECIALIZATIONS
508 //
509 //=================================================================================================
510 
511 //*************************************************************************************************
513 template< typename MT1, typename MT2, typename MT3 >
514 struct DMatDMatAddExprTrait< TSMatDMatSubExpr<MT1,MT2>, MT3 >
515 {
516  public:
517  //**********************************************************************************************
519  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
520  IsDenseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
521  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
522  , typename DMatTSMatAddExprTrait< typename DMatDMatSubExprTrait<MT3,MT2>::Type, MT1 >::Type
523  , INVALID_TYPE >::Type Type;
525  //**********************************************************************************************
526 };
528 //*************************************************************************************************
529 
530 
531 //*************************************************************************************************
533 template< typename MT1, typename MT2, typename MT3 >
534 struct DMatTDMatAddExprTrait< TSMatDMatSubExpr<MT1,MT2>, MT3 >
535 {
536  public:
537  //**********************************************************************************************
539  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
540  IsDenseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
541  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
542  , typename DMatTSMatAddExprTrait< typename TDMatDMatSubExprTrait<MT3,MT2>::Type, MT1 >::Type
543  , INVALID_TYPE >::Type Type;
545  //**********************************************************************************************
546 };
548 //*************************************************************************************************
549 
550 
551 //*************************************************************************************************
553 template< typename MT1, typename MT2, typename MT3 >
554 struct DMatDMatSubExprTrait< TSMatDMatSubExpr<MT1,MT2>, MT3 >
555 {
556  public:
557  //**********************************************************************************************
559  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
560  IsDenseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
561  IsDenseMatrix<MT3>::value && IsRowMajorMatrix<MT3>::value
562  , typename TSMatDMatSubExprTrait< MT1, typename DMatDMatAddExprTrait<MT2,MT3>::Type >::Type
563  , INVALID_TYPE >::Type Type;
565  //**********************************************************************************************
566 };
568 //*************************************************************************************************
569 
570 
571 //*************************************************************************************************
573 template< typename MT1, typename MT2, typename MT3 >
574 struct DMatTDMatSubExprTrait< TSMatDMatSubExpr<MT1,MT2>, MT3 >
575 {
576  public:
577  //**********************************************************************************************
579  typedef typename SelectType< IsSparseMatrix<MT1>::value && IsColumnMajorMatrix<MT1>::value &&
580  IsDenseMatrix<MT2>::value && IsRowMajorMatrix<MT2>::value &&
581  IsDenseMatrix<MT3>::value && IsColumnMajorMatrix<MT3>::value
582  , typename TSMatDMatSubExprTrait< MT1, typename DMatTDMatAddExprTrait<MT2,MT3>::Type >::Type
583  , INVALID_TYPE >::Type Type;
585  //**********************************************************************************************
586 };
588 //*************************************************************************************************
589 
590 
591 //*************************************************************************************************
593 template< typename MT1, typename MT2, bool AF >
594 struct SubmatrixExprTrait< TSMatDMatSubExpr<MT1,MT2>, AF >
595 {
596  public:
597  //**********************************************************************************************
598  typedef typename SubExprTrait< typename SubmatrixExprTrait<const MT1,AF>::Type
599  , typename SubmatrixExprTrait<const MT2,AF>::Type >::Type Type;
600  //**********************************************************************************************
601 };
603 //*************************************************************************************************
604 
605 
606 //*************************************************************************************************
608 template< typename MT1, typename MT2 >
609 struct RowExprTrait< TSMatDMatSubExpr<MT1,MT2> >
610 {
611  public:
612  //**********************************************************************************************
613  typedef typename SubExprTrait< typename RowExprTrait<const MT1>::Type
614  , typename RowExprTrait<const MT2>::Type >::Type Type;
615  //**********************************************************************************************
616 };
618 //*************************************************************************************************
619 
620 
621 //*************************************************************************************************
623 template< typename MT1, typename MT2 >
624 struct ColumnExprTrait< TSMatDMatSubExpr<MT1,MT2> >
625 {
626  public:
627  //**********************************************************************************************
628  typedef typename SubExprTrait< typename ColumnExprTrait<const MT1>::Type
629  , typename ColumnExprTrait<const MT2>::Type >::Type Type;
630  //**********************************************************************************************
631 };
633 //*************************************************************************************************
634 
635 } // namespace blaze
636 
637 #endif
bool canAlias(const T *alias) const
Returns whether the expression can alias with the given address alias.
Definition: TSMatDMatSubExpr.h:215
Compile time check whether the given type is a temporary vector or matrix type.This type trait class ...
Definition: IsTemporary.h:87
size_t columns() const
Returns the current number of columns of the matrix.
Definition: TSMatDMatSubExpr.h:183
ReturnType operator()(size_t i, size_t j) const
2D-access to the matrix elements.
Definition: TSMatDMatSubExpr.h:161
Header file for the subtraction trait.
void smpSubAssign(DenseMatrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP subtraction assignment of a matrix to dense matrix.
Definition: DenseMatrix.h:151
Efficient implementation of a compressed matrix.The CompressedMatrix class template is the represent...
Definition: CompressedMatrix.h:197
MT1::ResultType RT1
Result type of the left-hand side sparse matrix expression.
Definition: TSMatDMatSubExpr.h:91
#define BLAZE_CONSTRAINT_MUST_BE_DENSE_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a dense, N-dimensional matrix type...
Definition: DenseMatrix.h:79
Header file for the ColumnExprTrait class template.
RightOperand rightOperand() const
Returns the right-hand side dense matrix operand.
Definition: TSMatDMatSubExpr.h:203
ResultType::OppositeType OppositeType
Result type with opposite storage order for expression template evaluations.
Definition: TSMatDMatSubExpr.h:114
LeftOperand leftOperand() const
Returns the left-hand side transpose sparse matrix operand.
Definition: TSMatDMatSubExpr.h:193
Header file for the sparse matrix SMP implementation.
RightOperand rhs_
Right-hand side dense matrix of the subtraction expression.
Definition: TSMatDMatSubExpr.h:236
const This & CompositeType
Data type for composite expression templates.
Definition: CompressedMatrix.h:2384
Type ElementType
Type of the sparse matrix elements.
Definition: CompressedMatrix.h:249
Header file for the AddExprTrait class template.
Header file for the Computation base class.
Base class for dense matrices.The DenseMatrix class is a base class for all dense matrix classes...
Definition: DenseMatrix.h:70
Base class for sparse matrices.The SparseMatrix class is a base class for all sparse matrix classes...
Definition: Forward.h:104
Constraint on the data type.
const ResultType CompositeType
Data type for composite expression templates.
Definition: TSMatDMatSubExpr.h:122
MT2::ReturnType RN2
Return type of the right-hand side dense matrix expression.
Definition: TSMatDMatSubExpr.h:94
Constraint on the data type.
Constraint on the data type.
void smpAddAssign(DenseMatrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP addition assignment of a matrix to a dense matrix.
Definition: DenseMatrix.h:121
Compile time type selection.The SelectType class template selects one of the two given types T1 and T...
Definition: SelectType.h:59
Header file for the IsTemporary type trait class.
#define BLAZE_CONSTRAINT_MUST_BE_COLUMN_MAJOR_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a column-major dense or sparse matri...
Definition: StorageOrder.h:161
LeftOperand lhs_
Left-hand side sparse matrix of the subtraction expression.
Definition: TSMatDMatSubExpr.h:235
Header file for the dense matrix SMP implementation.
Header file for the DenseMatrix base class.
void assign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the assignment of a matrix to a matrix.
Definition: Matrix.h:179
Header file for the MatMatSubExpr base class.
const DenseIterator< Type > operator+(const DenseIterator< Type > &it, ptrdiff_t inc)
Addition between a DenseIterator and an integral value.
Definition: DenseIterator.h:556
ResultType::TransposeType TransposeType
Transpose type for expression template evaluations.
Definition: TSMatDMatSubExpr.h:115
#define BLAZE_CONSTRAINT_MUST_BE_REFERENCE_TYPE(T)
Constraint on the data type.In case the given data type T is not a reference type, a compilation error is created.
Definition: Reference.h:78
Constraints on the storage order of matrix types.
Evaluation of the return type of a subtraction expression.Via this type trait it is possible to evalu...
Definition: SubExprTrait.h:103
Header file for the SelectType class template.
Header file for the RowExprTrait class template.
Header file for all forward declarations for expression class templates.
bool isAliased(const T *alias) const
Returns whether the expression is aliased with the given address alias.
Definition: TSMatDMatSubExpr.h:228
void smpAssign(DenseMatrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the SMP assignment of a matrix to a dense matrix.
Definition: DenseMatrix.h:91
Header file for the SubmatrixExprTrait class template.
#define BLAZE_CONSTRAINT_MUST_BE_ROW_MAJOR_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a row-major dense or sparse matrix t...
Definition: StorageOrder.h:81
const Type & ReturnType
Return type for expression template evaluations.
Definition: CompressedMatrix.h:2383
Header file for run time assertion macros.
void addAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the addition assignment of a matrix to a matrix.
Definition: Matrix.h:209
const DenseIterator< Type > operator-(const DenseIterator< Type > &it, ptrdiff_t inc)
Subtraction between a DenseIterator and an integral value.
Definition: DenseIterator.h:585
Expression object for transpose sparse matrix-dense matrix subtractions.The TSMatDMatSubExpr class re...
Definition: Forward.h:134
void subAssign(Matrix< MT1, SO1 > &lhs, const Matrix< MT2, SO2 > &rhs)
Default implementation of the subtraction assignment of a matrix to matrix.
Definition: Matrix.h:239
MT1::ReturnType RN1
Return type of the left-hand side sparse matrix expression.
Definition: TSMatDMatSubExpr.h:93
MT2::ResultType RT2
Result type of the right-hand side dense matrix expression.
Definition: TSMatDMatSubExpr.h:92
SelectType< IsExpression< MT2 >::value, const MT2, const MT2 & >::Type RightOperand
Composite type of the right-hand side sparse matrix expression.
Definition: TSMatDMatSubExpr.h:128
#define BLAZE_CONSTRAINT_MATRICES_MUST_HAVE_SAME_STORAGE_ORDER(T1, T2)
Constraint on the data type.In case either of the two given data types T1 or T2 is not a matrix type ...
Definition: StorageOrder.h:283
TSMatDMatSubExpr(const MT1 &lhs, const MT2 &rhs)
Constructor for the TSMatDMatSubExpr class.
Definition: TSMatDMatSubExpr.h:145
ResultType::ElementType ElementType
Resulting element type.
Definition: TSMatDMatSubExpr.h:116
SubTrait< RT1, RT2 >::Type ResultType
Result type for expression template evaluations.
Definition: TSMatDMatSubExpr.h:113
const SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
Return type for expression template evaluations.
Definition: TSMatDMatSubExpr.h:119
SelectType< IsExpression< MT1 >::value, const MT1, const MT1 & >::Type LeftOperand
Composite type of the left-hand side dense matrix expression.
Definition: TSMatDMatSubExpr.h:125
#define BLAZE_FUNCTION_TRACE
Function trace macro.This macro can be used to reliably trace function calls. In case function tracin...
Definition: FunctionTrace.h:157
This ResultType
Result type for expression template evaluations.
Definition: CompressedMatrix.h:2379
SubExprTrait< RN1, RN2 >::Type ExprReturnType
Expression return type for the subscript operator.
Definition: TSMatDMatSubExpr.h:107
size_t columns(const Matrix< MT, SO > &m)
Returns the current number of columns of the matrix.
Definition: Matrix.h:154
Header file for basic type definitions.
Base template for the SubTrait class.
Definition: SubTrait.h:141
size_t rows() const
Returns the current number of rows of the matrix.
Definition: TSMatDMatSubExpr.h:173
Header file for the SubExprTrait class template.
size_t rows(const Matrix< MT, SO > &m)
Returns the current number of rows of the matrix.
Definition: Matrix.h:138
#define BLAZE_INTERNAL_ASSERT(expr, msg)
Run time assertion macro for internal checks.In case of an invalid run time expression, the program execution is terminated. The BLAZE_INTERNAL_ASSERT macro can be disabled by setting the BLAZE_USER_ASSERTION flag to zero or by defining NDEBUG during the compilation.
Definition: Assert.h:101
#define BLAZE_CONSTRAINT_MUST_BE_SPARSE_MATRIX_TYPE(T)
Constraint on the data type.In case the given data type T is not a sparse, N-dimensional matrix type...
Definition: SparseMatrix.h:79
Compile time check whether the given type is an expression template.This type trait class tests wheth...
Definition: IsExpression.h:87
Header file for the IsExpression type trait class.
TSMatDMatSubExpr< MT1, MT2 > This
Type of this TSMatDMatSubExpr instance.
Definition: TSMatDMatSubExpr.h:112
Header file for the FunctionTrace class.