dvector.h

Go to the documentation of this file.

/*

  Copyright (C) 2000, 2001 Silicon Graphics, Inc.  All Rights Reserved.

  This program is free software; you can redistribute it and/or modify it
  under the terms of version 2 of the GNU General Public License as
  published by the Free Software Foundation.

  This program is distributed in the hope that it would be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  

  Further, this software is distributed without any warranty that it is
  free of the rightful claim of any third person regarding infringement 
  or the like.  Any license provided herein, whether implied or 
  otherwise, applies only to this software file.  Patent licenses, if 
  any, provided herein do not apply to combinations of this program with 
  other software, or any other product whatsoever.  

  You should have received a copy of the GNU General Public License along
  with this program; if not, write the Free Software Foundation, Inc., 59
  Temple Place - Suite 330, Boston MA 02111-1307, USA.

  Contact information:  Silicon Graphics, Inc., 1600 Amphitheatre Pky,
  Mountain View, CA 94043, or:

  http://www.sgi.com

  For further information regarding this notice, see:

  http://oss.sgi.com/projects/GenInfo/NoticeExplan

*/


#ifndef dvector_INCLUDED
#define dvector_INCLUDED
#ifdef __cplusplus
extern "C" {
#endif


#ifndef ND_RCS_ID
#define ND_RCS_ID
#ifdef _KEEP_RCS_ID
#endif /* _KEEP_RCS_ID */
#endif

#include "defs.h"
#include "errors.h"
#include "mempool.h"


typedef enum {
  DIR_POS=1,
  DIR_NEG=2,
  DIR_EQ=4,
  DIR_POSNEG=3,
  DIR_POSEQ=5,
  DIR_NEGEQ=6,
  DIR_STAR=7
} DIRECTION;

/* DEP is implemented as a 16 bit quantity */
/* Bit 15 is on if the distance is constant */
/* Bits 12-14  give the direction */
/* Bits 0-11 give the distance + offset (offset=2048) */
typedef mINT16  DEP;

#define DISTANCE_FLAG_PRIVATE 0x8000
#define DISTANCE_MASK_PRIVATE 0x0FFF
#define DISTANCE_OFFSET_PRIVATE 2048
#define DIRECTION_MASK_PRIVATE 0x7000
#define MAX_BOUND_PRIVATE 4095
#define MAX_DISTANCE_PRIVATE 2047
#define MIN_DISTANCE_PRIVATE -2048

extern DEP DEP_SetDistance(INT32 distance);
extern void DEP_Lex_Pos_Decompose(DEP dep,MEM_POOL *pool,DEP **pos, 
    DEP **neg, BOOL keep_pos_equals,BOOL keep_neg_equals) ;

extern DEP DEP_Lex_Pos_Compose(DEP *pos, DEP *neg, BOOL *pos_has_eq,
        BOOL *neg_has_eq);

inline BOOL DEP_IsDistance(DEP dep)
{
  return(dep & DISTANCE_FLAG_PRIVATE);
}

inline INT32 DEP_Distance(DEP dep)
{
  Is_True(DEP_IsDistance(dep),("DEP_Distance called on non-constant dist."));
  return(((INT32) (dep & DISTANCE_MASK_PRIVATE)) - DISTANCE_OFFSET_PRIVATE);
}

inline UINT32 DEP_DistanceBound(DEP dep)
{
  return(((UINT32) (dep & DISTANCE_MASK_PRIVATE)) - DISTANCE_OFFSET_PRIVATE);
}

inline DIRECTION DEP_Direction(DEP dep)
{
  return((DIRECTION) ((dep & DIRECTION_MASK_PRIVATE) >> 12)); 
}

inline DEP DEP_MAKE_DIST_CONST_PRIVATE(DEP dep)
{
  return (dep | DISTANCE_FLAG_PRIVATE);
}

inline DEP DEP_MAKE_DIST_NON_CONST_PRIVATE(DEP dep)
{
  return( dep & (~DISTANCE_FLAG_PRIVATE));
}

/* set the direction bits, don't fiddle with anything else */
inline DEP DEP_SET_DIR_PRIVATE(DEP dep,DIRECTION direction)
{
  dep &= (~DIRECTION_MASK_PRIVATE);
  dep  |= ((mINT16) direction) << 12;
  return (dep);
}

/* set the distance bits, don't fiddle with anything else */
/* assumes distance is withing bounds */
inline DEP DEP_SET_DIST_PRIVATE(DEP dep,INT32 distance)
{
  dep &= (~DISTANCE_MASK_PRIVATE);
  dep = (mINT16) (dep | (distance + DISTANCE_OFFSET_PRIVATE));
  return (dep);
}



/* DEPV */

/* DEPV is implemented as an array of DEP, which is assumed to be mINT16 */
/* Element 0..num_dim give the individual deps */
typedef DEP DEPV;  


#define DEPV_Dep(depv,i) depv[i]


inline void DEPV_Free(MEM_POOL *mem_pool,DEPV *depv)
{
  MEM_POOL_FREE(mem_pool,depv);
}

extern DEP DEP_SetDirection(DIRECTION direction);
extern DEP DEP_UnionDirection(DEP dep,DIRECTION direction);
extern DEP DEP_Negate(DEP dep);
extern void  DIRECTION_Print(DIRECTION dir,FILE *fp);
extern void  DEP_Print(const DEP dep,FILE *fp);
extern void  DEP_PrintBound(const DEP dep,FILE *fp);
extern DEPV *DEPV_Create(MEM_POOL *mem_pool,UINT8 num_dim);
extern DEPV *DEPV_CreateStar(MEM_POOL *mem_pool,UINT8 num_dim);
extern DEPV *DEPV_CreateEqual(MEM_POOL *mem_pool,UINT8 num_dim);
extern DEPV *DEPV_Copy(MEM_POOL *mem_pool, DEPV *depv, UINT8 num_dim);
extern void DEPV_Print(const DEPV *depv,FILE *fp, UINT8 num_dim);
extern void DEPV_PrintBound(const DEPV *depv,FILE *fp, UINT8 num_dim);

#ifdef __cplusplus
}
#endif

#endif /* dvector_INCLUDED */