1    	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2    	/*                                                                           */
3    	/*                  This file is part of the program and library             */
4    	/*         SCIP --- Solving Constraint Integer Programs                      */
5    	/*                                                                           */
6    	/*  Copyright (c) 2002-2023 Zuse Institute Berlin (ZIB)                      */
7    	/*                                                                           */
8    	/*  Licensed under the Apache License, Version 2.0 (the "License");          */
9    	/*  you may not use this file except in compliance with the License.         */
10   	/*  You may obtain a copy of the License at                                  */
11   	/*                                                                           */
12   	/*      http://www.apache.org/licenses/LICENSE-2.0                           */
13   	/*                                                                           */
14   	/*  Unless required by applicable law or agreed to in writing, software      */
15   	/*  distributed under the License is distributed on an "AS IS" BASIS,        */
16   	/*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
17   	/*  See the License for the specific language governing permissions and      */
18   	/*  limitations under the License.                                           */
19   	/*                                                                           */
20   	/*  You should have received a copy of the Apache-2.0 license                */
21   	/*  along with SCIP; see the file LICENSE. If not visit scipopt.org.         */
22   	/*                                                                           */
23   	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
24   	
25   	/**@file   struct_history.h
26   	 * @ingroup INTERNALAPI
27   	 * @brief  datastructures for branching and inference history
28   	 * @author Tobias Achterberg
29   	 */
30   	
31   	/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
32   	
33   	#ifndef __SCIP_STRUCT_HISTORY_H__
34   	#define __SCIP_STRUCT_HISTORY_H__
35   	
36   	
37   	#include "scip/def.h"
38   	#include "scip/type_history.h"
39   	
40   	#ifdef __cplusplus
41   	extern "C" {
42   	#endif
43   	
44   	/** branching and inference history information for single variable independent of the domain value */
45   	struct SCIP_History
46   	{
47   	   SCIP_Real             pscostcount[2];     /**< nr of (partial) summands in down/upwards pseudo costs (may be fractional) */
48   	   SCIP_Real             pscostweightedmean[2]; /**< weighted mean of (partial) pseudo cost values for down/upwards branching */
49   	   SCIP_Real             pscostvariance[2];  /**< weighted variance of (partial) pseudo cost history for down/upwards branching */
50   	   SCIP_Real             vsids[2];           /**< degree of how often the variable was reason for a conflict */
51   	   SCIP_Real             conflengthsum[2];   /**< overall length of all active conflicts for which the variable gave reason */
52   	   SCIP_Real             inferencesum[2];    /**< degree of how often branching on the variable lead to inference of another bound */
53   	   SCIP_Real             cutoffsum[2];       /**< degree of how often branching on the variable lead to an infeasible sub problem */
54   	   SCIP_Real             ratio;              /**< Most recently computed value of the unpowered ratio (phi^l) in the Treemodel rules */
55   	   SCIP_Real             balance;            /**< Most recent value of r/l used to compute a ratio in the Treemodel rules */
56   	   SCIP_Real             gmieff;             /**< Most recent efficacy value of a GMI cut for the var row when basic / frac */
57   	   SCIP_Real             gmieffsum;          /**< Sum efficacy values of GMI cut for the var row when basic / frac */
58   	   SCIP_Real             ngmi;               /**< Number of GMI cuts generated from rows of this var when basic / frac */
59   	   SCIP_Bool             ratiovalid;         /**< Whether the ratio value is valid for the Treemodel rules */
60   	   SCIP_Longint          nactiveconflicts[2];/**< number of active conflicts for which the variable gave reason */
61   	   SCIP_Longint          nbranchings[2];     /**< nr of times, the variable changed its bounds due to branching */
62   	   SCIP_Longint          branchdepthsum[2];  /**< sum of depth levels, at which the branching bound changes took place */
63   	};
64   	
65   	/** branching and inference history information for single variable dependent on the domain value */
66   	struct SCIP_ValueHistory
67   	{
68   	   SCIP_HISTORY**        histories;          /**< branching and inference history information for individual domain values */
69   	   SCIP_Real*            values;             /**< (sorted) array containing the domain values */
70   	   int                   nvalues;            /**< number of different domain values */
71   	   int                   sizevalues;         /**< size of the both arrays */
72   	};
73   	
74   	#ifdef __cplusplus
75   	}
76   	#endif
77   	
78   	#endif
79