---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LDT / V0-4-0

Constituent: test_bt     Tag: linux-gcc

---

         

---

BTE.h File Reference

Binary Tree Encoding interface file. More...

This graph shows which files directly or indirectly include this file:

Classes
struct	_BTE_compressed
	Combines the compressed word, its encoding scheme and its size in bits in one structure. More...
Typedefs
typedef struct _BTE_compressed	BTE_compressed
	Typedef for struct _BTE_compressed.
Functions
BTE_compressed	BTE_wordCompress (unsigned int w)
unsigned int	BTE_wordEncode (unsigned int w, unsigned int pattern, unsigned int scheme_size)
unsigned int	BTE_wordPattern (unsigned int w)
unsigned int	BTE_wordSize (unsigned int w, unsigned int pattern, unsigned int scheme)
unsigned int	BTE_wordSchemeSize (unsigned int w, unsigned int pattern)
unsigned int	BTE_wordSizes (unsigned int w, unsigned int pattern)
BTE_compressed	BTE_shortCompress (unsigned short int w)
unsigned int	BTE_shortEncode (unsigned short int w, unsigned int pattern, unsigned int scheme_size)
unsigned int	BTE_shortPattern (unsigned short int w)
unsigned int	BTE_shortSize (unsigned short int w, unsigned int pattern, unsigned int scheme)
unsigned int	BTE_shortSchemeSize (unsigned short w, unsigned int pattern)
unsigned int	BTE_shortSizes (unsigned short int w, unsigned int pattern)
static __inline int	BTE_size (unsigned int scheme_size)
	Extracts the size, in bits, from the scheme/size word.
static __inline int	BTE_scheme (unsigned int scheme_size)
	Extracts the encoding scheme, from the scheme/size word.

---

Detailed Description

Binary Tree Encoding interface file.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: BTE.h,v 1.3 2009/04/29 23:06:40 russell Exp $

Interface specification for routines to encode bit strings using a binary tree.

---

Typedef Documentation

BTE_compressed

Typedef for struct _BTE_compressed.

This is the return value of the convenience function BTE_wordCompress.

---

Function Documentation

static __inline int BTE_scheme

(

unsigned int

schemeSize

)

[static]

Extracts the encoding scheme, from the scheme/size word.

Returns:

The encoding scheme to be used

Parameters:

schemeSize

The word containing the packed scheme and size fields. This is returned by BTE_wordSchemeSize

static __inline int BTE_size

(

unsigned int

schemeSize

)

[static]

Extracts the size, in bits, from the scheme/size word.

Returns:

The size field

Parameters:

schemeSize

The word containing the packed scheme and size fields. This is returned by BTE_wordSchemeSize

---