Hitmap 1.3
 All Data Structures Namespaces Files Functions Variables Typedefs Friends Macros Groups Pages
Data Structures | Macros | Functions | Variables
hit_sig.h File Reference
#include "hit_sigP.h"
Include dependency graph for hit_sig.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  HitSig
 

Macros

#define hit_sigCard(sig)
 
#define hit_sigCmp(s1, s2)
 
#define hit_sigIn(sig, ind)
 
#define hit_sigTileToArray(sig, ind)
 
#define hit_sigArrayToTile(sig, ind)
 

Functions

HitSig hit_sigIntersect (HitSig s1, HitSig s2)
 

Variables

HitSig HIT_SIG_NULL
 
HitSig HIT_SIG_WHOLE
 

Detailed Description

Signatures for dense or strided domains.

These functionalities allows to manage Signatures that define a 1-dimensional index space which is dense, or has strided indexes with regular intervals.

Version
1.0
Author
Arturo Gonzalez-Escribano
Javier Fresno Bausela
Carlos de Blas Carton
Date
Jun 2010

Definition in file hit_sig.h.

Macro Definition Documentation

#define hit_sigArrayToTile (   sig,
  ind 
)

Translate an index in array coordinate system to tile coordinates.

Parameters
[in]sigHitSig Domain signature.
[in]indint Index value.
Return values
intIndex value in tile coordinate system.

Definition at line 209 of file hit_sig.h.

#define hit_sigCard (   sig)

Compute the cardinality of a domain signature.

Parameters
[in]sigHitSig Domain signature.
Return values
intCount of valid indexes in the domain.

Definition at line 162 of file hit_sig.h.

#define hit_sigCmp (   s1,
  s2 
)

Compare two signatures.

Parameters
[in]s1HitSig Domain signature.
[in]s2HitSig Domain signature.
Return values
intLogical value. True if the two signatures are equal.

Definition at line 174 of file hit_sig.h.

#define hit_sigIn (   sig,
  ind 
)

Determine if an index is a valid index in a signature domain.

Parameters
[in]sigHitSig Domain signature.
[in]indint Index value.
Return values
intLogical value. True if ind is a valid index in the domain.

Definition at line 186 of file hit_sig.h.

#define hit_sigTileToArray (   sig,
  ind 
)

Translate an index in tile coordinate system to array coordinates.

Parameters
[in]sigHitSig Domain signature.
[in]indint Index value.
Return values
intIndex value in array coordinate system.

Definition at line 198 of file hit_sig.h.

Function Documentation

HitSig hit_sigIntersect ( HitSig  s1,
HitSig  s2 
)

Intersect two signatures.

Returns a new signature with the indexes that both domains have in common.

Author
Arturo Gonzalez-Escribano
Date
Oct 2011
Parameters
[in]s1Domain signature.
[in]s2Domain signature.
Returns
The signature representing the intersection. HIT_SIG_NULL if the intersection is empty.

Computes intersection of two signatures

Definition at line 86 of file hit_sig.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

HitSig HIT_SIG_NULL

Null value for domain signatures.

The cardinality of this domain value is 0 elements.

Definition at line 48 of file hit_sig.c.

HitSig HIT_SIG_WHOLE

Special value: Whole domain.

Special value to indicate in tile selections that the whole collection of indexes of another signature should be selected. The cardinality of this domain value is 0 elements.

See Also
hit_tileSelect()

Definition at line 49 of file hit_sig.c.