MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Attributes | List of all members
RTOp_MutableSubVector Struct Reference

#include <RTOp.h>

Public Attributes

RTOp_index_type global_offset
 
RTOp_index_type sub_dim
 
RTOp_value_typevalues
 
ptrdiff_t values_stride
 

Detailed Description

Struct for a mutable sub-vector.

The corresponding entries in the global vector x(j) (one based) are as follows:

x( vec.global_offset + k )
  = vec.values[ vec.value_stride * (k-1) ]

for k = 1...vec.sub_dim

The stride member vec.value_stride may be positive (>0), negative (<0) but not zero (0). A negative stride vec.value_stride < 0 allows a reverse traversal of the elements in a vector. A zero stride vec.value_stride == 0 would allow a vector with all the elements the same and therefore is not a target of a transformation operation.

To avoid making mistakes in setting the members of this struct use one of the helper functions RTOp_mutable_sub_vector() or RTOp_mutable_sub_vector_null().

Definition at line 330 of file RTOp.h.

Member Data Documentation

RTOp_index_type RTOp_MutableSubVector::global_offset

Definition at line 332 of file RTOp.h.

RTOp_index_type RTOp_MutableSubVector::sub_dim

Definition at line 334 of file RTOp.h.

RTOp_value_type* RTOp_MutableSubVector::values

Definition at line 336 of file RTOp.h.

ptrdiff_t RTOp_MutableSubVector::values_stride

Definition at line 338 of file RTOp.h.


The documentation for this struct was generated from the following file: