Description of Offset

Offset		Programmers Guide
		Contents \| Index \| Search

Category:utilities

Component type:concept

Description

This utility is in charge of mapping TwoD coordinates to a location in the linear memory of a dense matrix.

Refinement of

Associated types

Concept	Type name	Description
`NonNegativeIntegralType`	`X::size_type`
`size_type`	`X::M`	Static major dimension
`size_type`	`X::N`	Static major dimension
`Dimension`	`X::dim_type`	type for dimensions
`Dimension`	`X::band_type`	Type for bandwidth
`Tag`	`X::strideability`	Can we use rows and columns helper functions?
`Offset`	`X::transpose_type`

Notations

Definitions

Expression semantics

Description	Expression	Semantics
	`X()`
	`X(o)`
	`X(m, n, ld)`
	`X(m, n, ld, bw)`
	`X(t)`
Maps the (i,j) point from TwoD coords to a linear offset	`o.elt(i,j)`
The offset to the start of the ith OneD part of the TwoD	`o.oned_offset(i)`
The length of the ith OneD part	`o.oned_length(i)`
The size of the outer Container of the TwoD	`o.twod_length()`
The distance from one element to the next, usually 1	`o.stride()`
The total size of the memory allocated to the TwoD	`X::size(m, n, sub, super)`
The major dimension size	`o.major()`
The minor dimension size	`o.minor()`

Function specification

Name	Function	Complexity

Invariants

Models

Notes

See also