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

  PURPOSE        : private header file for pruning algorithms
  NOTES          :

  AUTHOR         : Tobias Schreiner
  DATE           : 13.3.94

  CHANGED BY     : Jochen Biedermann
  RCS VERSION    : $Revision: 2.8 $
  LAST CHANGE    : $Date: 1998/02/25 15:27:32 $

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

******************************************************************************/
#ifndef _PRUN_F_DEFINED_
#define  _PRUN_F_DEFINED_

/* begin global section */

#define PR_ALL_PATTERNS -1

#define DEFAULT_TRAIN_CYCLES 1000
#define DEFAULT_RETRAIN_CYCLES 100
#define DEFAULT_ERROR_INCREASE 10.0
#define DEFAULT_ACCEPTED_ERROR 5.0
#define DEFAULT_MIN_ERROR 1.0
#define DEFAULT_OBS_INIT_PARAMETER 0.000001

int pr_trainCycles = DEFAULT_TRAIN_CYCLES,
    pr_retrainCycles = DEFAULT_RETRAIN_CYCLES,
    pr_recreate = TRUE,
    pr_refresh = FALSE,
    pr_inputPruning = TRUE,
    pr_hiddenPruning = TRUE;

float pr_maxErrorInc = DEFAULT_ERROR_INCREASE,
      pr_acceptedError = DEFAULT_ACCEPTED_ERROR,
      pr_minError = DEFAULT_MIN_ERROR,
      pr_obs_initParameter = DEFAULT_OBS_INIT_PARAMETER;


void pr_checkDeadUnits (void);
krui_err pr_calcMeanDeviation (int pattern, float *sum_error);

krui_err PRUNE_Mag (int pattern);

krui_err PRUNE_OBD (int pattern);

krui_err PRUNE_OBS (int pattern);

krui_err PRUNE_Skeletonization (int pattern);

krui_err PRUNE_Noncontributing (int pattern);

void pr_obs_setInitParameter (float param);

krui_err pr_callPrunFunc (int pattern);

void pr_setInputPruning (int value);

void pr_setHiddenPruning (int value);

/* end global section */

/* begin private section */

#define SMALL_WEIGHT 0.0001

#define PR_CONST        1
#define PR_SAME         2
#define PR_REVERSE      3

#define UFLAG_PRUNEFLAG 0x8000


typedef krui_err (* PrunFuncPtr) ();

static struct Unit *pr_candidateTargetUnit, *pr_candidateUnit;
static struct Link *pr_candidateLink;
static float pr_candidateSaliency, pr_candidateStddev;
static int pr_candidateSourceUnitNo, pr_candidatePass, pr_Pass;

/* variables only used by OBS */
static int pr_candidateLinkNo, pr_noOfLinks;
static RbfFloatMatrix pr_inverseHessian, pr_derivVector, pr_helpHX, pr_helpXH;

/* functions */

static void pr_updateNoOfLinks (struct Unit *unit_ptr, struct Link *link_ptr);

static void pr_mag_processLink (struct Unit *unit_ptr, struct Link *link_ptr);

static void pr_obd_processLink (struct Unit *unit_ptr, struct Link *link_ptr,
				float delta, float delta2);
static void pr_obd_checkLink (struct Unit *unit_ptr, struct Link *link_ptr);

static void pr_obs_countLinks ();
static void pr_obs_calculateDerivative (struct Link *link_ptr,
					float help, int weight_no);
static void pr_obs_calculateDerivVector (struct Unit *output_unit);
static krui_err pr_obs_updateInverseHessian (int no_of_patterns);
static krui_err pr_obs_calculateInverseHessian (int pattern);
static void pr_obs_processLink (struct Unit *unit_ptr,
				struct Link *link_ptr,
				int weight_no);
static void pr_obs_updateLink (struct Link *link_ptr,
			       float update_const,
			       int weight_no);

static void pr_skel_processLink (struct Unit *unit_ptr, struct Link *link_ptr);
static void pr_skel_check_saliency (struct Unit *unit_ptr);

static krui_err pr_nc_calc_stddev (int pattern, struct Unit *this_unit_ptr);
static void     pr_nc_check_stddev (struct Unit *unit_ptr, struct Unit *unit_ptr2);
static krui_err pr_nc_process_succ_unit (struct Unit *unit_ptr, struct Link *link_ptr);
static void     pr_nc_mark_all_pred (struct Unit *root_unit_ptr);
static krui_err pr_nc_remove_unit (void);
#if 0
static void     pr_nc_output (void);
#endif
/* end private section */

#endif /* _PRUN_F_DEFINED_ */