FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
anneal.h
Go to the documentation of this file.
1 /*
2  Copyright (c) 2011 Cisco and/or its affiliates.
3 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15 */
16 
17 #ifndef __included_anneal_h__
18 #define __included_anneal_h__
19 
20 #include <vppinfra/clib.h>
21 #include <vppinfra/format.h>
22 #include <vppinfra/random.h>
23 #include <math.h>
24 
25 typedef struct
26 {
27  /* Initial temperature */
29 
30  /* Temperature fraction at each step, 0.95 is reasonable */
32 
33  /* Number of temperatures used */
35 
36  /* Number of configurations tried at each temperature */
38 
40 #define CLIB_ANNEAL_VERBOSE (1<<0)
41 #define CLIB_ANNEAL_MINIMIZE (1<<1) /* mutually exclusive */
42 #define CLIB_ANNEAL_MAXIMIZE (1<<2) /* mutually exclusive */
43 
44  /* Random number seed, set to ensure repeatable results */
46 
47  /* Opaque data passed to callbacks */
48  void *opaque;
49 
50  /* Final temperature (output) */
52 
53  /* Final metric (output) */
55 
56  /* Suggested initial temperature (output) */
58 
59 
60  /*--- Callbacks ---*/
61 
62  /* objective function to minimize */
63  f64 (*anneal_metric) (void *opaque);
64 
65  /* Generate a new configuration */
66  void (*anneal_new_configuration) (void *opaque);
67 
68  /* Restore the previous configuration */
69  void (*anneal_restore_previous_configuration) (void *opaque);
70 
71  /* Save best configuration found e.g at a certain temperature */
72  void (*anneal_save_best_configuration) (void *opaque);
73 
74  /* restore best configuration found e.g at a certain temperature */
75  void (*anneal_restore_best_configuration) (void *opaque);
76 
78 
80 
81 #endif /* __included_anneal_h__ */
82 
83 /*
84  * fd.io coding-style-patch-verification: ON
85  *
86  * Local Variables:
87  * eval: (c-set-style "gnu")
88  * End:
89  */
clib_anneal_param_t::random_seed
u32 random_seed
Definition: anneal.h:45
clib.h
clib_anneal_param_t::temperature_step
f64 temperature_step
Definition: anneal.h:31
clib_anneal_param_t::number_of_configurations_per_temperature
u32 number_of_configurations_per_temperature
Definition: anneal.h:37
clib_anneal
void clib_anneal(clib_anneal_param_t *p)
Definition: anneal.c:53
clib_anneal_param_t::number_of_temperatures
u32 number_of_temperatures
Definition: anneal.h:34
math.h
random.h
clib_anneal_param_t::flags
u32 flags
Definition: anneal.h:39
clib_anneal_param_t::initial_temperature
f64 initial_temperature
Definition: anneal.h:28
f64
double f64
Definition: types.h:142
format.h
clib_anneal_param_t::final_metric
f64 final_metric
Definition: anneal.h:54
clib_anneal_param_t
Definition: anneal.h:25
clib_anneal_param_t::final_temperature
f64 final_temperature
Definition: anneal.h:51
clib_anneal_param_t::opaque
void * opaque
Definition: anneal.h:48
u32
unsigned int u32
Definition: types.h:88
clib_anneal_param_t::suggested_initial_temperature
f64 suggested_initial_temperature
Definition: anneal.h:57