File: ratemeyerhaeseler.h

package info (click to toggle)
iqtree 1.5.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 9,780 kB
  • ctags: 11,529
  • sloc: cpp: 96,162; ansic: 59,874; python: 242; sh: 189; makefile: 45
file content (162 lines) | stat: -rw-r--r-- 4,555 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/***************************************************************************
 *   Copyright (C) 2009 by BUI Quang Minh   *
 *   minh.bui@univie.ac.at   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef RATEMEYERHAESELER_H
#define RATEMEYERHAESELER_H

#include "rateheterogeneity.h"
#include "tools.h"
#include "iqtree.h"


/**
Implementation for site-specific rates of Meyer & von Haeseler (2003)
Inherited from Optimization and the double vector for storing site-specific rates

	@author BUI Quang Minh <minh.bui@univie.ac.at>
*/
class RateMeyerHaeseler : public RateHeterogeneity, public DoubleVector
{
public:
	/**
		constructor
	*/
    RateMeyerHaeseler(char *file_name, PhyloTree *tree, bool rate_type);

    RateMeyerHaeseler();

	/**
		destructor
	*/
    ~RateMeyerHaeseler();

	void readRateFile(char *rate_file);

	/**
		@return true 
	*/
	virtual bool isSiteSpecificRate() { return true; }

	/**
		get the number of rate categories. 
		@return the number of rate categories
	*/
	//virtual int getNRate() { return size(); }


	/**
		return the number of dimensions
	*/
	virtual int getNDim();

	/**
		get the rate of a specified category
		@param category category ID from 0 to #category-1
		@return the rate of the specified category
	*/
	//virtual double getRate(int category);

	/**
		get the rate of a specified site-pattern. Default returns 1.0 since it is homogeneous model
		@param ptn pattern ID 
		@return the rate of the specified site-pattern
	*/
	virtual double getPtnRate(int ptn);

	/**
		Compute site-specific rates. Override this for Gamma model
		@param pattern_rates (OUT) pattern rates. Resizing if necesary
        @return total number of categories
	*/
	virtual int computePatternRates(DoubleVector &pattern_rates, IntVector &pattern_cat);

	void getRates(DoubleVector &rates);


	void setRates(DoubleVector &rates);

	void initializeRates();

	/**
		optimize parameters, the rates in this case
		@return the best likelihood 
	*/
	virtual double optimizeParameters(double epsilon);

	/**
		optimize rate of site
		@param pattern target pattern
		@return the optimized rate value, also update the corresponding element of the vector
	*/
	double optimizeRate(int pattern);

	/**
		optimize rates of all site-patterns
	*/
	virtual void optimizeRates();


	/**
		This function is inherited from Optimization class for optimizting site rates 
		@param value x-value of the function
		@return f(value) of function f you want to minimize
	*/
	virtual double computeFunction(double value);

	/**
		This function calculate f(value), first derivative f'(value) and 2nd derivative f''(value).
		@param value x-value of the function
		@param df (OUT) first derivative
		@param ddf (OUT) second derivative
		@return f(value) of function f you want to minimize
	*/
	virtual void computeFuncDerv(double value, double &df, double &ddf);


	void runIterativeProc(Params &params, IQTree &tree);

	/**
		distance matrix inferred from the path lengths of the tree (not from the sequences)
	*/
	double *dist_mat;


protected:

	char *rate_file;

	/**
		current pattern under optimization. Note that this is not thread-safe
	*/
	int optimizing_pattern;

	/**
		FALSE to use MH Model, FALSE for using tree-likelihood
	*/
	bool rate_mh;

	double cur_scale;

	PhyloTree *ptn_tree;

	void prepareRateML(IntVector &ptn_id);
	void completeRateML();
};

#endif