ocrm.h

在linux系统下开发研究移动通信的工具型代码

#ifndef _OCRM_H
#define _OCRM_H

/* 
 * $Log: ocrm.h,v $
 * Revision 1.1  2000/05/03 14:30:04  bjc97r
 * Initial revision
 *
 */


/* Code Generation Algorithm
   OH: original Hadamard transform or Sylvester construction,
   MH: modified Hadamard transform as in Adachi's paper */
typedef enum { OH, MH } OCodeGenMode;

extern int ocrm_init( void );
  /* It initializes the  OCodeTree table entries.
     ocrm_init() should be called before any ocrm- functions.
     0 is returned on successful initialization. */

extern void ocrm_end( void );
  /* It deallocates ocrm_table and reset init flag */

extern int ocrm_create_code_tree( int base_deg, int max_deg,
			   OCodeGenMode gen_mode );
  /* It create an Multi-Rate Orthogonal code resource binary tree
     and initializes the binary tree with free orthogonal indicies
     according to the given code index generation mode.
     The code tree id is returned */

extern void ocrm_destroy_code_tree( int id );
  /* The function deallocates the memory space for tree nodes.
     The corresponding flags are set */

extern int ocrm_get_code( int id, int deg, int *serial );
  /* It gives the next available orthogonal code index of 
     the given degree. The found valid code index is returned.
     The position in the code tree is saved in *serial.
     This value should be used for free the code index.
     The code index is returned if one is available,
     otherwise -1 is returned */

extern void ocrm_free_code( int id, int serial );
  /* It makes the code index available by marking it as free. */

extern void ocrm_print_tree( int id );
  /* This prints all the information for the tree. */

extern void ocrm_free_index ( int id, int deg, int index );
  /* It makes the code index available */

#endif /* _OCRM_H */