/*****************************************************************************
  FILE           : $Source: /projects/higgs1/SNNS/CVS/SNNS/kernel/sources/cc_modify.ph,v $
  SHORTNAME      : cc_modify.ph
  SNNS VERSION   : 4.2

  PURPOSE        : Header file of correspondent '.c' file
  NOTES          : 

  AUTHOR         : Juergen Gatter
  DATE           : 

  CHANGED BY     : 
  RCS VERSION    : $Revision: 1.4 $
  LAST CHANGE    : 

    Copyright (c) 1990-1995  SNNS Group, IPVR, Univ. Stuttgart, FRG
    Copyright (c) 1996-1998  SNNS Group, WSI, Univ. Tuebingen, FRG

******************************************************************************/
#ifndef _CC_MODIFY_DEFINED_
#define  _CC_MODIFY_DEFINED_

/* begin global definition section */

krui_err  cc_InitModificationVariables(void);
   /* inits some global Varibales. */

krui_err cc_TestWhetherParametersAreValid(void);
   /* is the Parameter-Input in the Windows valid ? */

krui_err cc_allocateMemoryForModifications(void);
   /* allocates Memory needed by some of the Modifications    */
   /* i.E. ccr_ListOfChosenUnits, ccs_GroupList,ccs_GroupData */

void cc_deallocateMemory(void);
   /* deallocates the above allocated Memory                              */

double cc_modifyHighScore(struct Unit* SpecialUnitPtr, int s, double old);
   /* modifies the HighScore according the actual Modification       */
   /* s is the No (0..Max) of the Special Unit, old is the unchanged */
   /* HighScore. The calling routine uses the changed HighScore to   */
   /* determine the best Special Unit.                               */

void cc_actualizeGroupHighscores(double Score,int s,struct Unit* UnitPtr);
   /* if more then one group is used, this routine actualises the  */
   /* according datas. Parameters see above.                       */

int cc_calculateNoOfNewUnits(void);
   /* How much Units do we have to install ? */

struct Unit*  cc_getModifiedBestSpecialUnitPtr(int GroupNo);
   /* get the best SpecialUnit according to the actual GroupNo */

bool cc_UnitsHaveToBeConnected(int SpecialUnitNo,struct Unit *UnitPtr);
   /* should the be a connection between the two units ?  */

krui_err cc_calculateConnections(int SpecUnitNo);
   /* calculate a connection table, if this must be done before */
   /* all units where checked.                                  */

void cc_MakeMiscCalculationsForModifications(void);
   /* make some misc calculations for the Modifications.    */
   /* Actually : CCM --> Calculate Layer Height.            */
   /*            CCS --> Calculate Correlation Output Units */
   /*                    and Groups.                        */
int* ccs_GroupList=NULL;
   /* dynamic Array [0..NoOfOutputUnits]. the Group in which */
   /* the specified Output-Unit is.                          */

/* end   global definition section */

/* begin privat definition section */

int ccm_CurrentLayerHeight=0;
   /* Height of the actual Layer in ccm */

int ccm_MissingUnitsInLayer=0;
   /* How much Units do we need 'til the layer is full ? */

int cco_ActualLayer;
   /* the layer of the actual Special Unit in cco */

struct CC_GROUP* ccs_GroupData=NULL;
   /* dynamic Array [0..NoOfGroups]. Def CC_GROUP --> cc_type.h   */
   /* the Actual best Unit and the correlated Score of the Group. */

int *ccr_ListOfChosenUnits=NULL;
   /* dynamic Array [0..CCR_NO_OF_LINKS].                      */
   /* Used by ccr. CCR_NO_OF_LINKS should be a small constant  */
   /* entered in the WindowParameters (for example 2,4 or 8).  */      

/* end privat definition section */

#endif /* _CC_MODIFY_DEFINED_ */