/******************************************************************************
 **	Filename:    intproto.c
 **	Purpose:     Definition of data structures for integer protos.
 **	Author:      Dan Johnson
 **	History:     Thu Feb  7 14:38:16 1991, DSJ, Created.
 **
 **	(c) Copyright Hewlett-Packard Company, 1988.
 ** Licensed under the Apache License, Version 2.0 (the "License");
 ** you may not use this file except in compliance with the License.
 ** You may obtain a copy of the License at
 ** http://www.apache.org/licenses/LICENSE-2.0
 ** Unless required by applicable law or agreed to in writing, software
 ** distributed under the License is distributed on an "AS IS" BASIS,
 ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 ** See the License for the specific language governing permissions and
 ** limitations under the License.
 ******************************************************************************/
/**----------------------------------------------------------------------------
          Include Files and Type Defines
----------------------------------------------------------------------------**/
#include "intproto.h"
#include "picofeat.h"
#include "debug.h"
#include "mfoutline.h"
#include "emalloc.h"
#include "const.h"
#include "ndminx.h"
#include "adaptmatch.h"
#include "globals.h"

//extern GetPicoFeatureLength();

#include <math.h>
#include <stdio.h>
#include <assert.h>

/* match debug display constants*/
#define DISPLAY_OFFSET  (0.5  * INT_CHAR_NORM_RANGE)
#define PROTO_PRUNER_SCALE  (4.0)

#define INT_DESCENDER (0.0  * INT_CHAR_NORM_RANGE - DISPLAY_OFFSET)
#define INT_BASELINE  (0.25 * INT_CHAR_NORM_RANGE - DISPLAY_OFFSET)
#define INT_XHEIGHT (0.75 * INT_CHAR_NORM_RANGE - DISPLAY_OFFSET)
#define INT_CAPHEIGHT (1.0  * INT_CHAR_NORM_RANGE - DISPLAY_OFFSET)

#define INT_XCENTER (0.5  * INT_CHAR_NORM_RANGE - DISPLAY_OFFSET)
#define INT_YCENTER (0.5  * INT_CHAR_NORM_RANGE - DISPLAY_OFFSET)
#define INT_XRADIUS (0.2  * INT_CHAR_NORM_RANGE)
#define INT_YRADIUS (0.2  * INT_CHAR_NORM_RANGE)
#define INT_MIN_X (- DISPLAY_OFFSET)
#define INT_MIN_Y (- DISPLAY_OFFSET)
#define INT_MAX_X (  DISPLAY_OFFSET)
#define INT_MAX_Y (  DISPLAY_OFFSET)
#define DOUBLE_OFFSET 0.095

/* define pad used to snap near horiz/vertical protos to horiz/vertical */
#define HV_TOLERANCE  (0.0025)   /* approx 0.9 degrees */

typedef enum
{ StartSwitch, EndSwitch, LastSwitch }
SWITCH_TYPE;
#define MAX_NUM_SWITCHES  3

typedef struct
{
  SWITCH_TYPE Type;
  inT8 X, Y;
  inT16 YInit;
  inT16 Delta;
}


FILL_SWITCH;

typedef struct
{
  uinT8 NextSwitch;
  uinT8 AngleStart, AngleEnd;
  inT8 X;
  inT16 YStart, YEnd;
  inT16 StartDelta, EndDelta;
  FILL_SWITCH Switch[MAX_NUM_SWITCHES];
}


TABLE_FILLER;

typedef struct
{
  inT8 X;
  inT8 YStart, YEnd;
  uinT8 AngleStart, AngleEnd;
}


FILL_SPEC;

enum IntmatcherDebugAction {
  IDA_ADAPTIVE,
  IDA_STATIC,
  IDA_BOTH
};

/**----------------------------------------------------------------------------
            Macros
----------------------------------------------------------------------------**/
/* macro for performing circular increments of bucket indices */
#define CircularIncrement(i,r)  (((i) < (r) - 1)?((i)++):((i) = 0))

/* macro for mapping floats to ints without bounds checking */
#define MapParam(P,O,N)   (floor (((P) + (O)) * (N)))

/*---------------------------------------------------------------------------
            Private Function Prototypes
----------------------------------------------------------------------------*/
FLOAT32 BucketStart(int Bucket, FLOAT32 Offset, int NumBuckets);

FLOAT32 BucketEnd(int Bucket, FLOAT32 Offset, int NumBuckets);

void DoFill(FILL_SPEC *FillSpec,
            CLASS_PRUNER Pruner,
            register uinT32 ClassMask,
            register uinT32 ClassCount,
            register uinT32 WordIndex);

BOOL8 FillerDone(TABLE_FILLER *Filler);

void FillPPCircularBits (uinT32
ParamTable[NUM_PP_BUCKETS][WERDS_PER_PP_VECTOR],
int Bit, FLOAT32 Center, FLOAT32 Spread);

void FillPPLinearBits (uinT32 ParamTable[NUM_PP_BUCKETS][WERDS_PER_PP_VECTOR],
int Bit, FLOAT32 Center, FLOAT32 Spread);

void GetCPPadsForLevel(int Level,
                       FLOAT32 *EndPad,
                       FLOAT32 *SidePad,
                       FLOAT32 *AnglePad);

C_COL GetMatchColorFor(FLOAT32 Evidence);

void GetNextFill(TABLE_FILLER *Filler, FILL_SPEC *Fill);

void InitTableFiller(FLOAT32 EndPad,
                     FLOAT32 SidePad,
                     FLOAT32 AnglePad,
                     PROTO Proto,
                     TABLE_FILLER *Filler);

int TruncateParam(FLOAT32 Param, int Min, int Max, char *Id);

/*
#if defined(__STDC__) || defined(__cplusplus)
# define	_ARGS(s) s
#else
# define	_ARGS(s) ()
#endif*/

/* /users/danj/wiseowl/src/danj/microfeatures/intproto.c
FLOAT32 BucketStart
  _ARGS((int Bucket,
  FLOAT32 Offset,
  int NumBuckets));

FLOAT32 BucketEnd
  _ARGS((int Bucket,
  FLOAT32 Offset,
  int NumBuckets));

void DoFill
  _ARGS((FILL_SPEC *FillSpec,
  CLASS_PRUNER Pruner,
  uinT32 ClassMask,
  uinT32 ClassCount,
  uinT32 WordIndex));

BOOL8 FillerDone
  _ARGS((TABLE_FILLER *Filler));

void FillPPCircularBits
  _ARGS((uinT32 ParamTable [NUM_PP_BUCKETS ][WERDS_PER_PP_VECTOR ],
  int Bit,
  FLOAT32 Center,
  FLOAT32 Spread));

void FillPPLinearBits
  _ARGS((uinT32 ParamTable [NUM_PP_BUCKETS ][WERDS_PER_PP_VECTOR ],
  int Bit,
  FLOAT32 Center,
  FLOAT32 Spread));

void GetCPPadsForLevel
  _ARGS((int Level,
  FLOAT32 *EndPad,
  FLOAT32 *SidePad,
  FLOAT32 *AnglePad));

C_COL GetMatchColorFor
  _ARGS((FLOAT32 Evidence));

void GetNextFill
  _ARGS((TABLE_FILLER *Filler,
  FILL_SPEC *Fill));

void InitTableFiller
  _ARGS((FLOAT32 EndPad,
  FLOAT32 SidePad,
  FLOAT32 AnglePad,
  PROTO Proto,
  TABLE_FILLER *Filler));

void RenderIntFeature
  _ARGS((SHAPE_LIST ShapeList,
  INT_FEATURE Feature,
  char *Color));

void RenderIntProto
  _ARGS((SHAPE_LIST ShapeList,
  INT_CLASS Class,
  PROTO_ID ProtoId,
  char *Color));

int TruncateParam
  _ARGS((FLOAT32 Param,
  int Min,
  int Max,
  char *Id));

#undef _ARGS
*/

/**----------------------------------------------------------------------------
        Global Data Definitions and Declarations
----------------------------------------------------------------------------**/
/* control knobs */
make_int_const (NumCPLevels, 3, MakeNumCPLevels);
make_float_const (CPAnglePadLoose, 45.0, MakeCPAnglePadLoose);
make_float_const (CPAnglePadMedium, 20.0, MakeCPAnglePadMedium);
make_float_const (CPAnglePadTight, 10.0, MakeCPAnglePadTight);
make_float_const (CPEndPadLoose, 0.5, MakeCPEndPadLoose);
make_float_const (CPEndPadMedium, 0.5, MakeCPEndPadMedium);
make_float_const (CPEndPadTight, 0.5, MakeCPEndPadTight);
make_float_const (CPSidePadLoose, 2.5, MakeCPSidePadLoose);
make_float_const (CPSidePadMedium, 1.2, MakeCPSidePadMedium);
make_float_const (CPSidePadTight, 0.6, MakeCPSidePadTight);
make_float_const (PPAnglePad, 45.0, MakePPAnglePad);
make_float_const (PPEndPad, 0.5, MakePPEndPad);
make_float_const (PPSidePad, 2.5, MakePPSidePad);


/**----------------------------------------------------------------------------
              Public Code
----------------------------------------------------------------------------**/
/*---------------------------------------------------------------------------*/
int AddIntClass(INT_TEMPLATES Templates, CLASS_ID ClassId, INT_CLASS Class) {
/*
 **	Parameters:
 **		Templates	templates to add new class to
 **		ClassId		class id to associate new class with
 **		Class		class data structure to add to templates
 **	Globals: none
 **	Operation: This routine adds a new class structure to a set of
 **		templates.
 **	Return: The class index of the new class.
 **	Exceptions: none
 **	History: Mon Feb 11 11:52:08 1991, DSJ, Created.
 */
  int Index;
  int Pruner;
  uinT32 *Word;

  assert (LegalClassId (ClassId));
  assert (UnusedClassIdIn (Templates, ClassId));

  Index = NumClassesIn (Templates);
  IndexForClassId (Templates, ClassId) = Index;
  ClassIdForIndex (Templates, Index) = ClassId;

  NumClassesIn (Templates)++;
  ClassForIndex (Templates, Index) = Class;

  if (NumClassesIn (Templates) > MaxNumClassesIn (Templates)) {
    Pruner = NumClassPrunersIn (Templates);
    NumClassPrunersIn (Templates)++;
    Templates->ClassPruner[Pruner] =
      (CLASS_PRUNER) Emalloc (sizeof (CLASS_PRUNER_STRUCT));

    for (Word = (uinT32 *) (Templates->ClassPruner[Pruner]);
      Word < (uinT32 *) (Templates->ClassPruner[Pruner]) + WERDS_PER_CP;
      *Word++ = 0);
  }

  return (Index);

}                                /* AddIntClass */


/*---------------------------------------------------------------------------*/
int AddIntConfig(INT_CLASS Class) {
/*
 **	Parameters:
 **		Class	class to add new configuration to
 **	Globals: none
 **	Operation: This routine returns the index of the next free config
 **		in Class.
 **	Return: Index of next free config.
 **	Exceptions: none
 **	History: Mon Feb 11 14:44:40 1991, DSJ, Created.
 */
  int Index;

  assert (NumIntConfigsIn (Class) < MAX_NUM_CONFIGS);

  Index = NumIntConfigsIn (Class);
  NumIntConfigsIn (Class)++;
  LengthForConfigId (Class, Index) = 0;
  return (Index);
}                                /* AddIntConfig */


/*---------------------------------------------------------------------------*/
int AddIntProto(INT_CLASS Class) {
/*
 **	Parameters:
 **		Class	class to add new proto to
 **	Globals: none
 **	Operation: This routine allocates the next free proto in Class and
 **		returns its index.
 **	Return: Proto index of new proto.
 **	Exceptions: none
 **	History: Mon Feb 11 13:26:41 1991, DSJ, Created.
 */
  int Index;
  int ProtoSetId;
  PROTO_SET ProtoSet;
  INT_PROTO Proto;
  register uinT32 *Word;

  if (NumIntProtosIn (Class) >= MAX_NUM_PROTOS)
    return (NO_PROTO);

  Index = NumIntProtosIn (Class);
  NumIntProtosIn (Class)++;

  if (NumIntProtosIn (Class) > MaxNumIntProtosIn (Class)) {
    ProtoSetId = NumProtoSetsIn (Class);
    NumProtoSetsIn (Class)++;

    ProtoSet = (PROTO_SET) Emalloc (sizeof (PROTO_SET_STRUCT));
    ProtoSetIn (Class, ProtoSetId) = ProtoSet;
    for (Word = (uinT32 *) (ProtoPrunerFor (ProtoSet));
      Word < (uinT32 *) (ProtoPrunerFor (ProtoSet)) + WERDS_PER_PP;
      *Word++ = 0);

    /* reallocate space for the proto lengths and install in class */
    Class->ProtoLengths = (uinT8 *) Erealloc (Class->ProtoLengths,
      MaxNumIntProtosIn (Class) *
      sizeof (uinT8));
  }

  /* initialize proto so its length is zero and it isn't in any configs */
  LengthForProtoId (Class, Index) = 0;
  Proto = ProtoForProtoId (Class, Index);
  for (Word = Proto->Configs;
    Word < Proto->Configs + WERDS_PER_CONFIG_VEC; *Word++ = 0);

  return (Index);

}                                /* AddIntProto */


/*---------------------------------------------------------------------------*/
void
AddProtoToClassPruner (PROTO Proto, CLASS_ID ClassId, INT_TEMPLATES Templates)
/*
 **	Parameters:
 **		Proto		floating-pt proto to add to class pruner
 **		ClassId		class id corresponding to Proto
 **		Templates	set of templates containing class pruner
 **	Globals:
 **		NumCPLevels	number of levels used in the class pruner
 **	Operation: This routine adds Proto to the class pruning tables
 **		for the specified class in Templates.
 **	Return: none
 **	Exceptions: none
 **	History: Wed Feb 13 08:49:54 1991, DSJ, Created.
 */
#define MAX_LEVEL     2
{
  CLASS_PRUNER Pruner;
  uinT32 ClassMask;
  uinT32 ClassCount;
  CLASS_INDEX ClassIndex;
  uinT32 WordIndex;
  int Level;
  FLOAT32 EndPad, SidePad, AnglePad;
  TABLE_FILLER TableFiller;
  FILL_SPEC FillSpec;

  ClassIndex = IndexForClassId (Templates, ClassId);
  Pruner = CPrunerFor (Templates, ClassIndex);
  WordIndex = CPrunerWordIndexFor (ClassIndex);
  ClassMask = CPrunerMaskFor (MAX_LEVEL, ClassIndex);

  for (Level = NumCPLevels - 1; Level >= 0; Level--) {
    GetCPPadsForLevel(Level, &EndPad, &SidePad, &AnglePad);
    ClassCount = CPrunerMaskFor (Level, ClassIndex);
    InitTableFiller(EndPad, SidePad, AnglePad, Proto, &TableFiller);

    while (!FillerDone (&TableFiller)) {
      GetNextFill(&TableFiller, &FillSpec);
      DoFill(&FillSpec, Pruner, ClassMask, ClassCount, WordIndex);
    }
  }
}                                /* AddProtoToClassPruner */


/*---------------------------------------------------------------------------*/
void AddProtoToProtoPruner(PROTO Proto, int ProtoId, INT_CLASS Class) {
/*
 **	Parameters:
 **		Proto	floating-pt proto to be added to proto pruner
 **		ProtoId	id of proto
 **		Class	integer class that contains desired proto pruner
 **	Globals: none
 **	Operation: This routine updates the proto pruner lookup tables
 **		for Class to include a new proto identified by ProtoId
 **		and described by Proto.
 **	Return: none
 **	Exceptions: none
 **	History: Fri Feb  8 13:07:19 1991, DSJ, Created.
 */
  FLOAT32 Angle, X, Y, Length;
  FLOAT32 Pad;
  int Index;
  PROTO_SET ProtoSet;

  if (ProtoId >= NumIntProtosIn (Class))
    cprintf ("AddProtoToProtoPruner:assert failed: %d < %d",
      ProtoId, NumIntProtosIn (Class));
  assert (ProtoId < NumIntProtosIn (Class));

  Index = IndexForProto (ProtoId);
  ProtoSet = ProtoSetIn (Class, SetForProto (ProtoId));

  Angle = ProtoAngle (Proto);
  FillPPCircularBits (ProtoSet->ProtoPruner[PRUNER_ANGLE], Index,
    Angle + ANGLE_SHIFT, PPAnglePad / 360.0);

  Angle *= 2.0 * PI;
  Length = ProtoLength (Proto);

  X = ProtoX (Proto) + X_SHIFT;
  Pad = max (fabs (cos (Angle)) * (Length / 2.0 +
    PPEndPad * GetPicoFeatureLength ()),
    fabs (sin (Angle)) * (PPSidePad * GetPicoFeatureLength ()));

  FillPPLinearBits (ProtoSet->ProtoPruner[PRUNER_X], Index, X, Pad);

  Y = ProtoY (Proto) + Y_SHIFT;
  Pad = max (fabs (sin (Angle)) * (Length / 2.0 +
    PPEndPad * GetPicoFeatureLength ()),
    fabs (cos (Angle)) * (PPSidePad * GetPicoFeatureLength ()));

  FillPPLinearBits (ProtoSet->ProtoPruner[PRUNER_Y], Index, Y, Pad);

}                                /* AddProtoToProtoPruner */


/*---------------------------------------------------------------------------*/
int BucketFor(FLOAT32 Param, FLOAT32 Offset, int NumBuckets) {
/*
 **	Parameters:
 **		Param		parameter value to map into a bucket number
 **		Offset		amount to shift param before mapping it
 **		NumBuckets	number of buckets to map param into
 **	Globals: none
 **	Operation: This routine maps a parameter value into a bucket between
 **		0 and NumBuckets-1.  Offset is added to the parameter
 **		before mapping it.  Values which map to buckets outside
 **		the range are truncated to fit within the range.  Mapping
 **		is done by truncating rather than rounding.
 **	Return: Bucket number corresponding to Param + Offset.
 **	Exceptions: none
 **	History: Thu Feb 14 13:24:33 1991, DSJ, Created.
 */
  int Bucket;

  Bucket = (int) MapParam (Param, Offset, NumBuckets);
  if (Bucket < 0)
    Bucket = 0;
  else if (Bucket >= NumBuckets)
    Bucket = NumBuckets - 1;
  return (Bucket);

}                                /* BucketFor */


/*---------------------------------------------------------------------------*/
int CircBucketFor(FLOAT32 Param, FLOAT32 Offset, int NumBuckets) {
/*
 **	Parameters:
 **		Param		parameter value to map into a circular bucket
 **		Offset		amount to shift param before mapping it
 **		NumBuckets	number of buckets to map param into
 **	Globals: none
 **	Operation: This routine maps a parameter value into a bucket between
 **		0 and NumBuckets-1.  Offset is added to the parameter
 **		before mapping it.  Values which map to buckets outside
 **		the range are wrapped to a new value in a circular fashion.
 **		Mapping is done by truncating rather than rounding.
 **	Return: Bucket number corresponding to Param + Offset.
 **	Exceptions: none
 **	History: Thu Feb 14 13:24:33 1991, DSJ, Created.
 */
  int Bucket;

  Bucket = (int) MapParam (Param, Offset, NumBuckets);
  if (Bucket < 0)
    Bucket += NumBuckets;
  else if (Bucket >= NumBuckets)
    Bucket -= NumBuckets;
  return (Bucket);

}                                /* CircBucketFor */


/*---------------------------------------------------------------------------*/
void ConvertConfig(BIT_VECTOR Config, int ConfigId, INT_CLASS Class) {
/*
 **	Parameters:
 **		Config		config to be added to class
 **		ConfigId	id to be used for new config
 **		Class		class to add new config to
 **	Globals: none
 **	Operation: This operation updates the config vectors of all protos
 **		in Class to indicate that the protos with 1's in Config
 **		belong to a new configuration identified by ConfigId.
 **		It is assumed that the length of the Config bit vector is
 **		equal to the number of protos in Class.
 **	Return: none
 **	Exceptions: none
 **	History: Mon Feb 11 14:57:31 1991, DSJ, Created.
 */
  int ProtoId;
  INT_PROTO Proto;
  int TotalLength;

  for (ProtoId = 0, TotalLength = 0;
    ProtoId < NumIntProtosIn (Class); ProtoId++)
  if (test_bit (Config, ProtoId)) {
    Proto = ProtoForProtoId (Class, ProtoId);
    SET_BIT (Proto->Configs, ConfigId);
    TotalLength += LengthForProtoId (Class, ProtoId);
  }
  LengthForConfigId (Class, ConfigId) = TotalLength;
}                                /* ConvertConfig */


/*---------------------------------------------------------------------------*/
void ConvertProto(PROTO Proto, int ProtoId, INT_CLASS Class) {
/*
 **	Parameters:
 **		Proto	floating-pt proto to be converted to integer format
 **		ProtoId	id of proto
 **		Class	integer class to add converted proto to
 **	Globals: none
 **	Operation: This routine converts Proto to integer format and
 **		installs it as ProtoId in Class.
 **	Return: none
 **	Exceptions: none
 **	History: Fri Feb  8 11:22:43 1991, DSJ, Created.
 */
  INT_PROTO P;
  FLOAT32 Param;

  assert (ProtoId < NumIntProtosIn (Class));

  P = ProtoForProtoId (Class, ProtoId);

  Param = CoefficientA (Proto) * 128;
  P->A = TruncateParam (Param, -128, 127, NULL);

  Param = -CoefficientB (Proto) * 256;
  P->B = TruncateParam (Param, 0, 255, NULL);

  Param = CoefficientC (Proto) * 128;
  P->C = TruncateParam (Param, -128, 127, NULL);

  Param = ProtoAngle (Proto) * 256;
  if (Param < 0 || Param >= 256)
    P->Angle = 0;
  else
    P->Angle = (uinT8) Param;

  /* round proto length to nearest integer number of pico-features */
  Param = (ProtoLength (Proto) / GetPicoFeatureLength ()) + 0.5;
  LengthForProtoId (Class, ProtoId) = TruncateParam (Param, 1, 255, NULL);
  if (LearningDebugLevel >= 2)
    cprintf ("Converted ffeat to (A=%d,B=%d,C=%d,L=%d)",
      P->A, P->B, P->C, LengthForProtoId (Class, ProtoId));
}                                /* ConvertProto */


/*---------------------------------------------------------------------------*/
INT_TEMPLATES CreateIntTemplates(CLASSES FloatProtos,
                                 const UNICHARSET& target_unicharset) {
/*
 **	Parameters:
 **		FloatProtos	prototypes in old floating pt format
 **	Globals: none
 **	Operation: This routine converts from the old floating point format
 **		to the new integer format.
 **	Return: New set of training templates in integer format.
 **	Exceptions: none
 **	History: Thu Feb  7 14:40:42 1991, DSJ, Created.
 */
  INT_TEMPLATES IntTemplates;
  CLASS_TYPE FClass;
  INT_CLASS IClass;
  int ClassId;
  int ProtoId;
  int ConfigId;

  IntTemplates = NewIntTemplates ();

  for (ClassId = 0; ClassId < target_unicharset.size(); ClassId++) {
    FClass = &(FloatProtos[ClassId]);
    if (NumProtosIn (FClass) > 0) {
      assert (UnusedClassIdIn (IntTemplates, ClassId));
      IClass = NewIntClass (NumProtosIn (FClass), NumConfigsIn (FClass));
      AddIntClass(IntTemplates, ClassId, IClass);

      for (ProtoId = 0; ProtoId < NumProtosIn (FClass); ProtoId++) {
        AddIntProto(IClass);
        ConvertProto (ProtoIn (FClass, ProtoId), ProtoId, IClass);
        AddProtoToProtoPruner (ProtoIn (FClass, ProtoId), ProtoId,
          IClass);
        AddProtoToClassPruner (ProtoIn (FClass, ProtoId), ClassId,
          IntTemplates);
      }

      for (ConfigId = 0; ConfigId < NumConfigsIn (FClass); ConfigId++) {
        AddIntConfig(IClass);
        ConvertConfig (ConfigIn (FClass, ConfigId), ConfigId, IClass);
      }
    }
  }
  return (IntTemplates);
}                                /* CreateIntTemplates */

/*---------------------------------------------------------------------------*/
void InitIntProtoVars() {
/*
 **	Parameters: none
 **	Globals: none
 **	Operation: Initialize the control variables for the integer proto
 **		routines.
 **	Return: none
 **	Exceptions: none
 **	History: Tue Feb 12 08:04:34 1991, DSJ, Created.
 */
  MakeNumCPLevels();
  MakeCPAnglePadLoose();
  MakeCPAnglePadMedium();
  MakeCPAnglePadTight();
  MakeCPEndPadLoose();
  MakeCPEndPadMedium();
  MakeCPEndPadTight();
  MakeCPSidePadLoose();
  MakeCPSidePadMedium();
  MakeCPSidePadTight();
  MakePPAnglePad();
  MakePPEndPad();
  MakePPSidePad();
}                                /* InitIntProtoVars */


/*---------------------------------------------------------------------------*/
INT_CLASS NewIntClass(int MaxNumProtos, int MaxNumConfigs) {
/*
 **	Parameters:
 **		MaxNumProtos	number of protos to allocate space for
 **		MaxNumConfigs	number of configs to allocate space for
 **	Globals: none
 **	Operation: This routine creates a new integer class data structure
 **		and returns it.  Sufficient space is allocated
 **		to handle the specified number of protos and configs.
 **	Return: New class created.
 **	Exceptions: none
 **	History: Fri Feb  8 10:51:23 1991, DSJ, Created.
 */
  INT_CLASS Class;
  PROTO_SET ProtoSet;
  int i;
  register uinT32 *Word;

  assert (MaxNumConfigs <= MAX_NUM_CONFIGS);

  Class = (INT_CLASS) Emalloc (sizeof (INT_CLASS_STRUCT));
  NumProtoSetsIn (Class) = ((MaxNumProtos + PROTOS_PER_PROTO_SET - 1) /
    PROTOS_PER_PROTO_SET);

  assert (NumProtoSetsIn (Class) <= MAX_NUM_PROTO_SETS);

  NumIntProtosIn (Class) = 0;
  NumIntConfigsIn (Class) = 0;

  for (i = 0; i < NumProtoSetsIn (Class); i++) {
    /* allocate space for a proto set, install in class, and initialize */
    ProtoSet = (PROTO_SET) Emalloc (sizeof (PROTO_SET_STRUCT));
    ProtoSetIn (Class, i) = ProtoSet;
    for (Word = (uinT32 *) (ProtoPrunerFor (ProtoSet));
      Word < (uinT32 *) (ProtoPrunerFor (ProtoSet)) + WERDS_PER_PP;
      *Word++ = 0);

    /* allocate space for the proto lengths and install in class */
  }
  Class->ProtoLengths = (uinT8 *) Emalloc (MaxNumIntProtosIn (Class) *
    sizeof (uinT8));

  return (Class);

}                                /* NewIntClass */


/*-------------------------------------------------------------------------*/
void free_int_class(  /*class to free */
                    INT_CLASS int_class) {
  int i;

  for (i = 0; i < NumProtoSetsIn (int_class); i++) {
    Efree (ProtoSetIn (int_class, i));
  }
  Efree (int_class->ProtoLengths);
  Efree(int_class);
}


/*---------------------------------------------------------------------------*/
INT_TEMPLATES NewIntTemplates() {
/*
 **	Parameters: none
 **	Globals: none
 **	Operation: This routine allocates a new set of integer templates
 **		initialized to hold 0 classes.
 **	Return: The integer templates created.
 **	Exceptions: none
 **	History: Fri Feb  8 08:38:51 1991, DSJ, Created.
 */
  INT_TEMPLATES T;
  int i;

  T = (INT_TEMPLATES) Emalloc (sizeof (INT_TEMPLATES_STRUCT));
  NumClassesIn (T) = 0;
  NumClassPrunersIn (T) = 0;

  /* initialize mapping tables */
  for (i = 0; i <= MAX_CLASS_ID; i++)
    IndexForClassId (T, i) = ILLEGAL_CLASS;
  for (i = 0; i < MAX_NUM_CLASSES; i++)
    ClassIdForIndex (T, i) = NO_CLASS;

  return (T);

}                                /* NewIntTemplates */


/*---------------------------------------------------------------------------*/
void free_int_templates(INT_TEMPLATES templates) {
  int i;

  for (i = 0; i < NumClassesIn (templates); i++)
    free_int_class (ClassForIndex (templates, i));
  for (i = 0; i < NumClassPrunersIn (templates); i++)
    Efree (templates->ClassPruner[i]);
  Efree(templates);
}


/*---------------------------------------------------------------------------*/
INT_TEMPLATES ReadIntTemplates(FILE *File, BOOL8 swap) {
/*
 **	Parameters:
 **		File		open file to read templates from
 **	Globals: none
 **	Operation: This routine reads a set of integer templates from
 **		File.  File must already be open and must be in the
 **		correct binary format.
 **	Return: Pointer to integer templates read from File.
 **	Exceptions: none
 **	History: Wed Feb 27 11:48:46 1991, DSJ, Created.
 */
  int i, j, x, y, z;
  int nread;
  int unicharset_size;
  int version_id = 0;
  INT_TEMPLATES Templates;
  CLASS_PRUNER Pruner;
  INT_CLASS Class;
  uinT8 *Lengths;
  PROTO_SET ProtoSet;

  /* first read the high level template struct */
  Templates = NewIntTemplates ();
  // Read Templates in parts for 64 bit compatibility.
  if (fread(&unicharset_size, sizeof(int), 1, File) != 1)
    cprintf ("Bad read of inttemp!\n");
  if (fread(&Templates->NumClasses, sizeof(int), 1, File) != 1 ||
      fread(&Templates->NumClassPruners, sizeof(int), 1, File) != 1)
    cprintf ("Bad read of inttemp!\n");
  // Swap status is determined automatically.
  swap = Templates->NumClassPruners < 0 ||
         Templates->NumClassPruners > MAX_NUM_CLASS_PRUNERS;
  if (swap) {
    reverse32 (&Templates->NumClassPruners);
    reverse32 (&Templates->NumClasses);
    reverse32 (&unicharset_size);
  }
  if (unicharset_size != unicharset.size()) {
    cprintf("Error: %d classes in inttemp while "
            "unicharset contains %d unichars.\n",
            unicharset_size, unicharset.size());
    exit(1);
  }
  if (Templates->NumClasses < 0) {
    // This file has a version id!
    version_id = -Templates->NumClasses;
    if (fread(&Templates->NumClasses, sizeof(Templates->NumClasses),
              1, File) != 1)
      cprintf("Bad read of inttemp!\n");
    if (swap)
      reverse32 (&Templates->NumClasses);
  }
  for (i = 0; i < unicharset_size; ++i) {
    if (fread(&Templates->IndexFor[i], sizeof(CLASS_INDEX), 1, File) != 1)
      cprintf("Bad read of inttemp!\n");
  }
  for (i = 0; i < NumClassesIn (Templates); ++i) {
    if (fread(&Templates->ClassIdFor[i], sizeof(CLASS_ID), 1, File) != 1)
      cprintf("Bad read of inttemp!\n");
  }
  if (swap) {
    for (i = 0; i < MAX_CLASS_ID + 1; i++)
      reverse16 (&Templates->IndexFor[i]);
    for (i = 0; i < MAX_NUM_CLASSES; i++)
      reverse32 (&Templates->ClassIdFor[i]);
  }

  /* then read in the class pruners */
  for (i = 0; i < NumClassPrunersIn (Templates); i++) {
    Pruner = (CLASS_PRUNER) Emalloc (sizeof (CLASS_PRUNER_STRUCT));
    if ((nread =
      fread ((char *) Pruner, 1, sizeof (CLASS_PRUNER_STRUCT),
      File)) != sizeof (CLASS_PRUNER_STRUCT))
      cprintf ("Bad read of inttemp!\n");
    if (swap) {
      for (j = 0; j < NUM_CP_BUCKETS; j++) {
        for (x = 0; x < NUM_CP_BUCKETS; x++) {
          for (y = 0; y < NUM_CP_BUCKETS; y++) {
            for (z = 0; z < WERDS_PER_CP_VECTOR; z++) {
              reverse32 (&Pruner[j][x][y][z]);
            }
          }
        }
      }
    }
    Templates->ClassPruner[i] = Pruner;
  }

  /* then read in each class */
  for (i = 0; i < NumClassesIn (Templates); i++) {
    /* first read in the high level struct for the class */
    Class = (INT_CLASS) Emalloc (sizeof (INT_CLASS_STRUCT));
    if (fread(&Class->NumProtos, sizeof(Class->NumProtos), 1, File) != 1 ||
        fread(&Class->NumProtoSets, sizeof(Class->NumProtoSets), 1, File) != 1 ||
        fread(&Class->NumConfigs, sizeof(Class->NumConfigs), 1, File) != 1)
      cprintf ("Bad read of inttemp!\n");
    if (version_id == 0) {
      // Only version 0 writes 5 pointless pointers to the file.
      for (j = 0; j < 5; ++j) {
        int junk;
        if (fread(&junk, sizeof(junk), 1, File) != 1)
          cprintf ("Bad read of inttemp!\n");
      }
    }
    for (j = 0; j < MAX_NUM_CONFIGS; ++j) {
      if (fread(&Class->ConfigLengths[j], sizeof(uinT16), 1, File) != 1)
        cprintf ("Bad read of inttemp!\n");
    }
    if (swap) {
      reverse16 (&Class->NumProtos);
      for (j = 0; j < MAX_NUM_CONFIGS; j++)
        reverse16 (&Class->ConfigLengths[j]);
    }
    ClassForIndex (Templates, i) = Class;

    /* then read in the proto lengths */
    Lengths = (uinT8 *) Emalloc (sizeof (uinT8) *
      MaxNumIntProtosIn (Class));
    if ((nread = fread ((char *) Lengths, sizeof (uinT8),
      MaxNumIntProtosIn (Class),
      File)) != MaxNumIntProtosIn (Class))
      cprintf ("Bad read of inttemp!\n");
    Class->ProtoLengths = Lengths;

    /* then read in the proto sets */
    for (j = 0; j < NumProtoSetsIn (Class); j++) {
      ProtoSet = (PROTO_SET) Emalloc (sizeof (PROTO_SET_STRUCT));
      if ((nread =
        fread ((char *) ProtoSet, 1, sizeof (PROTO_SET_STRUCT),
        File)) != sizeof (PROTO_SET_STRUCT))
        cprintf ("Bad read of inttemp!\n");
      if (swap) {
        for (x = 0; x < NUM_PP_PARAMS; x++)
          for (y = 0; y < NUM_PP_BUCKETS; y++)
            for (z = 0; z < WERDS_PER_PP_VECTOR; z++)
              reverse32 (&ProtoSet->ProtoPruner[x][y][z]);
        for (x = 0; x < PROTOS_PER_PROTO_SET; x++)
          for (y = 0; y < WERDS_PER_CONFIG_VEC; y++)
            reverse32 (&ProtoSet->Protos[x].Configs[y]);
      }
      ProtoSetIn (Class, j) = ProtoSet;
    }
  }
  return (Templates);
}                                /* ReadIntTemplates */

/*---------------------------------------------------------------------------*/
void WriteIntTemplates(FILE *File, INT_TEMPLATES Templates,
                       const UNICHARSET& target_unicharset) {
/*
 **	Parameters:
 **		File		open file to write templates to
 **		Templates	templates to save into File
 **	Globals: none
 **	Operation: This routine writes Templates to File.  The format
 **		is an efficient binary format.  File must already be open
 **		for writing.
 **	Return: none
 **	Exceptions: none
 **	History: Wed Feb 27 11:48:46 1991, DSJ, Created.
 */
  int i, j;
  INT_CLASS Class;
  int unicharset_size = target_unicharset.size();
  int version_id = -1;  // When negated by the reader -1 becomes +1 etc.

  /* first write the high level template struct */
  fwrite(&unicharset_size, sizeof(unicharset_size), 1, File);
  fwrite(&version_id, sizeof(version_id), 1, File);
  fwrite(&Templates->NumClassPruners, sizeof(Templates->NumClassPruners),
         1, File);
  fwrite(&Templates->NumClasses, sizeof(Templates->NumClasses), 1, File);
  fwrite(&Templates->IndexFor[0], sizeof(Templates->IndexFor[0]),
         unicharset_size, File);
  fwrite(&Templates->ClassIdFor[0], sizeof(Templates->ClassIdFor[0]),
         NumClassesIn(Templates), File);

  /* then write out the class pruners */
  for (i = 0; i < NumClassPrunersIn (Templates); i++)
    fwrite(Templates->ClassPruner[i],
           sizeof(CLASS_PRUNER_STRUCT), 1, File);

  /* then write out each class */
  for (i = 0; i < NumClassesIn(Templates); i++) {
    Class = ClassForIndex(Templates, i);

    /* first write out the high level struct for the class */
    fwrite(&Class->NumProtos, sizeof(Class->NumProtos), 1, File);
    fwrite(&Class->NumProtoSets, sizeof(Class->NumProtoSets), 1, File);
    fwrite(&Class->NumConfigs, sizeof(Class->NumConfigs), 1, File);
    for (j = 0; j < MAX_NUM_CONFIGS; ++j) {
      fwrite(&Class->ConfigLengths[j], sizeof(uinT16), 1, File);
    }

    /* then write out the proto lengths */
    fwrite ((char *) (Class->ProtoLengths), sizeof (uinT8),
      MaxNumIntProtosIn (Class), File);

    /* then write out the proto sets */
    for (j = 0; j < NumProtoSetsIn (Class); j++)
      fwrite ((char *) ProtoSetIn (Class, j),
        sizeof (PROTO_SET_STRUCT), 1, File);
  }
}                                /* WriteIntTemplates */


/**----------------------------------------------------------------------------
              Private Code
----------------------------------------------------------------------------**/
/*---------------------------------------------------------------------------*/
FLOAT32 BucketStart(int Bucket, FLOAT32 Offset, int NumBuckets) {
/*
 **	Parameters:
 **		Bucket		bucket whose start is to be computed
 **		Offset		offset used to map params to buckets
 **		NumBuckets	total number of buckets
 **	Globals: none
 **	Operation: This routine returns the parameter value which
 **		corresponds to the beginning of the specified bucket.
 **		The bucket number should have been generated using the
 **		BucketFor() function with parameters Offset and NumBuckets.
 **	Return: Param value corresponding to start position of Bucket.
 **	Exceptions: none
 **	History: Thu Feb 14 13:24:33 1991, DSJ, Created.
 */
  return (((FLOAT32) Bucket / NumBuckets) - Offset);

}                                /* BucketStart */


/*---------------------------------------------------------------------------*/
FLOAT32 BucketEnd(int Bucket, FLOAT32 Offset, int NumBuckets) {
/*
 **	Parameters:
 **		Bucket		bucket whose end is to be computed
 **		Offset		offset used to map params to buckets
 **		NumBuckets	total number of buckets
 **	Globals: none
 **	Operation: This routine returns the parameter value which
 **		corresponds to the end of the specified bucket.
 **		The bucket number should have been generated using the
 **		BucketFor() function with parameters Offset and NumBuckets.
 **	Return: Param value corresponding to end position of Bucket.
 **	Exceptions: none
 **	History: Thu Feb 14 13:24:33 1991, DSJ, Created.
 */
  return (((FLOAT32) (Bucket + 1) / NumBuckets) - Offset);
}                                /* BucketEnd */


/*---------------------------------------------------------------------------*/
void DoFill(FILL_SPEC *FillSpec,
            CLASS_PRUNER Pruner,
            register uinT32 ClassMask,
            register uinT32 ClassCount,
            register uinT32 WordIndex) {
/*
 **	Parameters:
 **		FillSpec	specifies which bits to fill in pruner
 **		Pruner		class pruner to be filled
 **		ClassMask	indicates which bits to change in each word
 **		ClassCount	indicates what to change bits to
 **		WordIndex	indicates which word to change
 **	Globals: none
 **	Operation: This routine fills in the section of a class pruner
 **		corresponding to a single x value for a single proto of
 **		a class.
 **	Return: none
 **	Exceptions: none
 **	History: Tue Feb 19 11:11:29 1991, DSJ, Created.
 */
  register int X, Y, Angle;
  register uinT32 OldWord;

  X = FillSpec->X;
  if (X < 0)
    X = 0;
  if (X >= NUM_CP_BUCKETS)
    X = NUM_CP_BUCKETS - 1;

  if (FillSpec->YStart < 0)
    FillSpec->YStart = 0;
  if (FillSpec->YEnd >= NUM_CP_BUCKETS)
    FillSpec->YEnd = NUM_CP_BUCKETS - 1;

  for (Y = FillSpec->YStart; Y <= FillSpec->YEnd; Y++)
    for (Angle = FillSpec->AngleStart;
  TRUE; CircularIncrement (Angle, NUM_CP_BUCKETS)) {
    OldWord = Pruner[X][Y][Angle][WordIndex];
    if (ClassCount > (OldWord & ClassMask)) {
      OldWord &= ~ClassMask;
      OldWord |= ClassCount;
      Pruner[X][Y][Angle][WordIndex] = OldWord;
    }
    if (Angle == FillSpec->AngleEnd)
      break;
  }
}                                /* DoFill */


/*---------------------------------------------------------------------------*/
BOOL8 FillerDone(TABLE_FILLER *Filler) {
/*
 **	Parameters:
 **		Filler		table filler to check if done
 **	Globals: none
 **	Operation: Return TRUE if the specified table filler is done, i.e.
 **		if it has no more lines to fill.
 **	Return: TRUE if no more lines to fill, FALSE otherwise.
 **	Exceptions: none
 **	History: Tue Feb 19 10:08:05 1991, DSJ, Created.
 */
  FILL_SWITCH *Next;

  Next = &(Filler->Switch[Filler->NextSwitch]);

  if (Filler->X > Next->X && Next->Type == LastSwitch)
    return (TRUE);
  else
    return (FALSE);

}                                /* FillerDone */


/*---------------------------------------------------------------------------*/
void
FillPPCircularBits (uinT32 ParamTable[NUM_PP_BUCKETS][WERDS_PER_PP_VECTOR],
int Bit, FLOAT32 Center, FLOAT32 Spread) {
/*
 **	Parameters:
 **		ParamTable	table of bit vectors, one per param bucket
 **		Bit		bit position in vectors to be filled
 **		Center		center of filled area
 **		Spread		spread of filled area
 **	Globals: none
 **	Operation: This routine sets Bit in each bit vector whose
 **		bucket lies within the range Center +- Spread.  The fill
 **		is done for a circular dimension, i.e. bucket 0 is adjacent
 **		to the last bucket.  It is assumed that Center and Spread
 **		are expressed in a circular coordinate system whose range
 **		is 0 to 1.
 **	Return: none
 **	Exceptions: none
 **	History: Tue Oct 16 09:26:54 1990, DSJ, Created.
 */
  int i, FirstBucket, LastBucket;

  if (Spread > 0.5)
    Spread = 0.5;

  FirstBucket = (int) floor ((Center - Spread) * NUM_PP_BUCKETS);
  if (FirstBucket < 0)
    FirstBucket += NUM_PP_BUCKETS;

  LastBucket = (int) floor ((Center + Spread) * NUM_PP_BUCKETS);
  if (LastBucket >= NUM_PP_BUCKETS)
    LastBucket -= NUM_PP_BUCKETS;
  if (LearningDebugLevel >= 2)
    cprintf ("Circular fill from %d to %d", FirstBucket, LastBucket);
  for (i = FirstBucket; TRUE; CircularIncrement (i, NUM_PP_BUCKETS)) {
    SET_BIT (ParamTable[i], Bit);

    /* exit loop after we have set the bit for the last bucket */
    if (i == LastBucket)
      break;
  }

}                                /* FillPPCircularBits */


/*---------------------------------------------------------------------------*/
void
FillPPLinearBits (uinT32 ParamTable[NUM_PP_BUCKETS][WERDS_PER_PP_VECTOR],
int Bit, FLOAT32 Center, FLOAT32 Spread) {
/*
 **	Parameters:
 **		ParamTable	table of bit vectors, one per param bucket
 **		Bit		bit number being filled
 **		Center		center of filled area
 **		Spread		spread of filled area
 **	Globals: none
 **	Operation: This routine sets Bit in each bit vector whose
 **		bucket lies within the range Center +- Spread.  The fill
 **		is done for a linear dimension, i.e. there is no wrap-around
 **		for this dimension.  It is assumed that Center and Spread
 **		are expressed in a linear coordinate system whose range
 **		is approximately 0 to 1.  Values outside this range will
 **		be clipped.
 **	Return: none
 **	Exceptions: none
 **	History: Tue Oct 16 09:26:54 1990, DSJ, Created.
 */
  int i, FirstBucket, LastBucket;

  FirstBucket = (int) floor ((Center - Spread) * NUM_PP_BUCKETS);
  if (FirstBucket < 0)
    FirstBucket = 0;

  LastBucket = (int) floor ((Center + Spread) * NUM_PP_BUCKETS);
  if (LastBucket >= NUM_PP_BUCKETS)
    LastBucket = NUM_PP_BUCKETS - 1;

  if (LearningDebugLevel >= 2)
    cprintf ("Linear fill from %d to %d", FirstBucket, LastBucket);
  for (i = FirstBucket; i <= LastBucket; i++)
    SET_BIT (ParamTable[i], Bit);

}                                /* FillPPLinearBits */


/*---------------------------------------------------------------------------*/

/*---------------------------------------------------------------------------*/
void GetCPPadsForLevel(int Level,
                       FLOAT32 *EndPad,
                       FLOAT32 *SidePad,
                       FLOAT32 *AnglePad) {
/*
 **	Parameters:
 **		Level		"tightness" level to return pads for
 **		EndPad		place to put end pad for Level
 **		SidePad		place to put side pad for Level
 **		AnglePad	place to put angle pad for Level
 **	Globals: none
 **	Operation: This routine copies the appropriate global pad variables
 **		into EndPad, SidePad, and AnglePad.  This is a kludge used
 **		to get around the fact that global control variables cannot
 **		be arrays.  If the specified level is illegal, the tightest
 **		possible pads are returned.
 **	Return: none (results are returned in EndPad, SidePad, and AnglePad.
 **	Exceptions: none
 **	History: Thu Feb 14 08:26:49 1991, DSJ, Created.
 */
  switch (Level) {
    case 0:
      *EndPad = CPEndPadLoose * GetPicoFeatureLength ();
      *SidePad = CPSidePadLoose * GetPicoFeatureLength ();
      *AnglePad = CPAnglePadLoose / 360.0;
      break;

    case 1:
      *EndPad = CPEndPadMedium * GetPicoFeatureLength ();
      *SidePad = CPSidePadMedium * GetPicoFeatureLength ();
      *AnglePad = CPAnglePadMedium / 360.0;
      break;

    case 2:
      *EndPad = CPEndPadTight * GetPicoFeatureLength ();
      *SidePad = CPSidePadTight * GetPicoFeatureLength ();
      *AnglePad = CPAnglePadTight / 360.0;
      break;

    default:
      *EndPad = CPEndPadTight * GetPicoFeatureLength ();
      *SidePad = CPSidePadTight * GetPicoFeatureLength ();
      *AnglePad = CPAnglePadTight / 360.0;
      break;
  }
  if (*AnglePad > 0.5)
    *AnglePad = 0.5;

}                                /* GetCPPadsForLevel */


/*---------------------------------------------------------------------------*/
C_COL GetMatchColorFor(FLOAT32 Evidence) {
/*
 **	Parameters:
 **		Evidence	evidence value to return color for
 **	Globals: none
 **	Operation:
 **	Return: Color which corresponds to specified Evidence value.
 **	Exceptions: none
 **	History: Thu Mar 21 15:24:52 1991, DSJ, Created.
 */

  assert (Evidence >= 0.0);
  assert (Evidence <= 1.0);

  if (Evidence >= 0.90)
    return White;
  else if (Evidence >= 0.75)
    return Green;
  else if (Evidence >= 0.50)
    return Red;
  else
    return Blue;
}                                /* GetMatchColorFor */


/*---------------------------------------------------------------------------*/
void GetNextFill(TABLE_FILLER *Filler, FILL_SPEC *Fill) {
/*
 **	Parameters:
 **		Filler		filler to get next fill spec from
 **		Fill		place to put spec for next fill
 **	Globals: none
 **	Operation: This routine returns (in Fill) the specification of
 **		the next line to be filled from Filler.  FillerDone() should
 **		always be called before GetNextFill() to ensure that we
 **		do not run past the end of the fill table.
 **	Return: none (results are returned in Fill)
 **	Exceptions: none
 **	History: Tue Feb 19 10:17:42 1991, DSJ, Created.
 */
  FILL_SWITCH *Next;

  /* compute the fill assuming no switches will be encountered */
  Fill->AngleStart = Filler->AngleStart;
  Fill->AngleEnd = Filler->AngleEnd;
  Fill->X = Filler->X;
  Fill->YStart = Filler->YStart >> 8;
  Fill->YEnd = Filler->YEnd >> 8;

  /* update the fill info and the filler for ALL switches at this X value */
  Next = &(Filler->Switch[Filler->NextSwitch]);
  while (Filler->X >= Next->X) {
    Fill->X = Filler->X = Next->X;
    if (Next->Type == StartSwitch) {
      Fill->YStart = Next->Y;
      Filler->StartDelta = Next->Delta;
      Filler->YStart = Next->YInit;
    }
    else if (Next->Type == EndSwitch) {
      Fill->YEnd = Next->Y;
      Filler->EndDelta = Next->Delta;
      Filler->YEnd = Next->YInit;
    }
    else {                       /* Type must be LastSwitch */
      break;
    }
    Filler->NextSwitch++;
    Next = &(Filler->Switch[Filler->NextSwitch]);
  }

  /* prepare the filler for the next call to this routine */
  Filler->X++;
  Filler->YStart += Filler->StartDelta;
  Filler->YEnd += Filler->EndDelta;

}                                /* GetNextFill */


/*---------------------------------------------------------------------------*/
void
InitTableFiller (FLOAT32 EndPad,
FLOAT32 SidePad,
FLOAT32 AnglePad, PROTO Proto, TABLE_FILLER * Filler)
/*
 **	Parameters:
 **		EndPad, SidePad, AnglePad	padding to add to proto
 **		Proto				proto to create a filler for
 **		Filler				place to put table filler
 **	Globals: none
 **	Operation: This routine computes a data structure (Filler)
 **		which can be used to fill in a rectangle surrounding
 **		the specified Proto.
 **	Return: none (results are returned in Filler)
 **	Exceptions: none
 **	History: Thu Feb 14 09:27:05 1991, DSJ, Created.
 */
#define XS          X_SHIFT
#define YS          Y_SHIFT
#define AS          ANGLE_SHIFT
#define NB          NUM_CP_BUCKETS
{
  FLOAT32 Angle;
  FLOAT32 X, Y, HalfLength;
  FLOAT32 Cos, Sin;
  FLOAT32 XAdjust, YAdjust;
  FPOINT Start, Switch1, Switch2, End;
  int S1 = 0;
  int S2 = 1;

  Angle = ProtoAngle (Proto);
  X = ProtoX (Proto);
  Y = ProtoY (Proto);
  HalfLength = ProtoLength (Proto) / 2.0;

  Filler->AngleStart = CircBucketFor (Angle - AnglePad, AS, NB);
  Filler->AngleEnd = CircBucketFor (Angle + AnglePad, AS, NB);
  Filler->NextSwitch = 0;

  if (fabs (Angle - 0.0) < HV_TOLERANCE || fabs (Angle - 0.5) < HV_TOLERANCE) {
    /* horizontal proto - handle as special case */
    Filler->X = BucketFor (X - HalfLength - EndPad, XS, NB);
    Filler->YStart = BucketFor (Y - SidePad, YS, NB * 256);
    Filler->YEnd = BucketFor (Y + SidePad, YS, NB * 256);
    Filler->StartDelta = 0;
    Filler->EndDelta = 0;
    Filler->Switch[0].Type = LastSwitch;
    Filler->Switch[0].X = BucketFor (X + HalfLength + EndPad, XS, NB);
  }
  else if (fabs (Angle - 0.25) < HV_TOLERANCE ||
  fabs (Angle - 0.75) < HV_TOLERANCE) {
    /* vertical proto - handle as special case */
    Filler->X = BucketFor (X - SidePad, XS, NB);
    Filler->YStart = BucketFor (Y - HalfLength - EndPad, YS, NB * 256);
    Filler->YEnd = BucketFor (Y + HalfLength + EndPad, YS, NB * 256);
    Filler->StartDelta = 0;
    Filler->EndDelta = 0;
    Filler->Switch[0].Type = LastSwitch;
    Filler->Switch[0].X = BucketFor (X + SidePad, XS, NB);
  }
  else {
    /* diagonal proto */

    if ((Angle > 0.0 && Angle < 0.25) || (Angle > 0.5 && Angle < 0.75)) {
      /* rising diagonal proto */
      Angle *= 2.0 * PI;
      Cos = fabs (cos (Angle));
      Sin = fabs (sin (Angle));

      /* compute the positions of the corners of the acceptance region */
      Start.x = X - (HalfLength + EndPad) * Cos - SidePad * Sin;
      Start.y = Y - (HalfLength + EndPad) * Sin + SidePad * Cos;
      End.x = 2.0 * X - Start.x;
      End.y = 2.0 * Y - Start.y;
      Switch1.x = X - (HalfLength + EndPad) * Cos + SidePad * Sin;
      Switch1.y = Y - (HalfLength + EndPad) * Sin - SidePad * Cos;
      Switch2.x = 2.0 * X - Switch1.x;
      Switch2.y = 2.0 * Y - Switch1.y;

      if (Switch1.x > Switch2.x) {
        S1 = 1;
        S2 = 0;
      }

      /* translate into bucket positions and deltas */
      Filler->X = (inT8) MapParam (Start.x, XS, NB);
      Filler->StartDelta = -(inT16) ((Cos / Sin) * 256);
      Filler->EndDelta = (inT16) ((Sin / Cos) * 256);

      XAdjust = BucketEnd (Filler->X, XS, NB) - Start.x;
      YAdjust = XAdjust * Cos / Sin;
      Filler->YStart = (inT16) MapParam (Start.y - YAdjust, YS, NB * 256);
      YAdjust = XAdjust * Sin / Cos;
      Filler->YEnd = (inT16) MapParam (Start.y + YAdjust, YS, NB * 256);

      Filler->Switch[S1].Type = StartSwitch;
      Filler->Switch[S1].X = (inT8) MapParam (Switch1.x, XS, NB);
      Filler->Switch[S1].Y = (inT8) MapParam (Switch1.y, YS, NB);
      XAdjust = Switch1.x - BucketStart (Filler->Switch[S1].X, XS, NB);
      YAdjust = XAdjust * Sin / Cos;
      Filler->Switch[S1].YInit =
        (inT16) MapParam (Switch1.y - YAdjust, YS, NB * 256);
      Filler->Switch[S1].Delta = Filler->EndDelta;

      Filler->Switch[S2].Type = EndSwitch;
      Filler->Switch[S2].X = (inT8) MapParam (Switch2.x, XS, NB);
      Filler->Switch[S2].Y = (inT8) MapParam (Switch2.y, YS, NB);
      XAdjust = Switch2.x - BucketStart (Filler->Switch[S2].X, XS, NB);
      YAdjust = XAdjust * Cos / Sin;
      Filler->Switch[S2].YInit =
        (inT16) MapParam (Switch2.y + YAdjust, YS, NB * 256);
      Filler->Switch[S2].Delta = Filler->StartDelta;

      Filler->Switch[2].Type = LastSwitch;
      Filler->Switch[2].X = (inT8) MapParam (End.x, XS, NB);
    }
    else {
      /* falling diagonal proto */
      Angle *= 2.0 * PI;
      Cos = fabs (cos (Angle));
      Sin = fabs (sin (Angle));

      /* compute the positions of the corners of the acceptance region */
      Start.x = X - (HalfLength + EndPad) * Cos - SidePad * Sin;
      Start.y = Y + (HalfLength + EndPad) * Sin - SidePad * Cos;
      End.x = 2.0 * X - Start.x;
      End.y = 2.0 * Y - Start.y;
      Switch1.x = X - (HalfLength + EndPad) * Cos + SidePad * Sin;
      Switch1.y = Y + (HalfLength + EndPad) * Sin + SidePad * Cos;
      Switch2.x = 2.0 * X - Switch1.x;
      Switch2.y = 2.0 * Y - Switch1.y;

      if (Switch1.x > Switch2.x) {
        S1 = 1;
        S2 = 0;
      }

      /* translate into bucket positions and deltas */
      Filler->X = (inT8) MapParam (Start.x, XS, NB);
      Filler->StartDelta = -(inT16) ((Sin / Cos) * 256);
      Filler->EndDelta = (inT16) ((Cos / Sin) * 256);

      XAdjust = BucketEnd (Filler->X, XS, NB) - Start.x;
      YAdjust = XAdjust * Sin / Cos;
      Filler->YStart = (inT16) MapParam (Start.y - YAdjust, YS, NB * 256);
      YAdjust = XAdjust * Cos / Sin;
      Filler->YEnd = (inT16) MapParam (Start.y + YAdjust, YS, NB * 256);

      Filler->Switch[S1].Type = EndSwitch;
      Filler->Switch[S1].X = (inT8) MapParam (Switch1.x, XS, NB);
      Filler->Switch[S1].Y = (inT8) MapParam (Switch1.y, YS, NB);
      XAdjust = Switch1.x - BucketStart (Filler->Switch[S1].X, XS, NB);
      YAdjust = XAdjust * Sin / Cos;
      Filler->Switch[S1].YInit =
        (inT16) MapParam (Switch1.y + YAdjust, YS, NB * 256);
      Filler->Switch[S1].Delta = Filler->StartDelta;

      Filler->Switch[S2].Type = StartSwitch;
      Filler->Switch[S2].X = (inT8) MapParam (Switch2.x, XS, NB);
      Filler->Switch[S2].Y = (inT8) MapParam (Switch2.y, YS, NB);
      XAdjust = Switch2.x - BucketStart (Filler->Switch[S2].X, XS, NB);
      YAdjust = XAdjust * Cos / Sin;
      Filler->Switch[S2].YInit =
        (inT16) MapParam (Switch2.y - YAdjust, YS, NB * 256);
      Filler->Switch[S2].Delta = Filler->EndDelta;

      Filler->Switch[2].Type = LastSwitch;
      Filler->Switch[2].X = (inT8) MapParam (End.x, XS, NB);
    }
  }
}                                /* InitTableFiller */


/*---------------------------------------------------------------------------*/
int TruncateParam(FLOAT32 Param, int Min, int Max, char *Id) {
/*
 **	Parameters:
 **		Param		parameter value to be truncated
 **		Min, Max	parameter limits (inclusive)
 **		Id		string id of parameter for error messages
 **	Globals: none
 **	Operation: This routine truncates Param to lie within the range
 **		of Min-Max inclusive.  If a truncation is performed, and
 **		Id is not null, an warning message is printed.
 **	Return: Truncated parameter.
 **	Exceptions: none
 **	History: Fri Feb  8 11:54:28 1991, DSJ, Created.
 */
  if (Param < Min) {
    if (Id)
      cprintf ("Warning: Param %s truncated from %f to %d!\n",
        Id, Param, Min);
    Param = Min;
  }
  else if (Param > Max) {
    if (Id)
      cprintf ("Warning: Param %s truncated from %f to %d!\n",
        Id, Param, Max);
    Param = Max;
  }
  return (int) floor (Param);

}                                /* TruncateParam */
