1 #ifndef MENU_INCLUDE
2 #define MENU_INCLUDE
3 /*------------------------------------------------------
4  Maximum likelihood estimation
5  of migration rate  and effectice population size
6  using a Metropolis-Hastings Monte Carlo algorithm
7  -------------------------------------------------------
8  M E N U   R O U T I N E S
9 
10  presents the menu and its submenus.
11  Peter Beerli 1996, Seattle
12       updated 2009, Tallahassee
13  beerli@fsu.edu
14 
15 Copyright 1996-2002 Peter Beerli and Joseph Felsenstein, Seattle WA
16 Copyright 2003-2009 Peter Beerli, Tallahassee FL
17 
18  Permission is hereby granted, free of charge, to any person obtaining
19  a copy of this software and associated documentation files (the
20  "Software"), to deal in the Software without restriction, including
21  without limitation the rights to use, copy, modify, merge, publish,
22  distribute, sublicense, and/or sell copies of the Software, and to
23  permit persons to whom the Software is furnished to do so, subject
24  to the following conditions:
25 
26  The above copyright notice and this permission notice shall be
27  included in all copies or substantial portions of the Software.
28 
29  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
32  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
33  ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
34  CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
35  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 
37 $Id: menu.h 2157 2013-04-16 22:27:40Z beerli $
38 -------------------------------------------------------*/
39 
40 #include "migration.h"
41 ///
42 /// print the title of the analysis to the log and the screen
43 /// \param file {stream pointer to which the title string is printed to}
44 /// \param options  {is the option structure that holds all general option data}
45 /// \returns {None}
46 void print_menu_title (FILE * file, option_fmt * options);
47 ///
48 /// print the acceptance ratio to the screen
49 /// \param a {likelihood of the newly proposed MCMC state}
50 /// \param b {likelihood of the old MCMC state
51 /// \param world {holds all runtime related material including the data and run-options structures}
52 /// \returns {None}
53 void print_menu_accratio (long a, long b, world_fmt *world);
54 ///
55 /// print the title to the outfile
56 /// \param world {holds all runtime related material including the data and run-options structures}
57 /// \param options  {is the option structure that holds all general option data}
58 /// \returns {the position in the output file}
59 long print_title (world_fmt * world, option_fmt * options);
60 ///
61 /// presents the menu to the user
62 /// \param options {is the option structure that holds all general option data}
63 /// \param world {holds all runtime related material including the data and run-options structures,
64 ///               but this is not really filled yet because all data related material is missing}
65 /// \param data  {holds all data related parts}
66 /// \returns {None}
67 void get_menu (option_fmt * options, world_fmt *world, data_fmt *data);
68 ///
69 /// presents title of the prior method
70 /// \param priorset {is an int that specifies the prior type}
71 /// \returns {a string with the name of the proposal method}
72 char * is_priortype(int priorset);
73 ///
74 /// presents title of the posterior method
75 /// \param proposalset {is a boolean to specify whether this is SPLICE or MH sampling scheme}
76 /// \returns {a string with the name of the proposal method}
77 char * is_proposaltype(boolean proposalset);
78 #endif /*MENU_INCLUDE */
79