File: constants.h

package info (click to toggle)
ray 2.3.1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 4,264 kB
  • ctags: 6,335
  • sloc: cpp: 49,973; sh: 325; makefile: 278; python: 168
file content (208 lines) | stat: -rw-r--r-- 4,621 bytes parent folder | download | duplicates (5)
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*
    Ray -- Parallel genome assemblies for parallel DNA sequencing
    Copyright (C) 2011, 2012, 2013 Sébastien Boisvert

	http://DeNovoAssembler.SourceForge.Net/

    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, version 3 of the License.

    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 have received a copy of the GNU General Public License
    along with this program (gpl-3.0.txt).  
	see <http://www.gnu.org/licenses/>
*/

#ifndef _constants
#define _constants

#ifndef CONFIG_RAY_VERSION
#define CONFIG_RAY_VERSION "Unknown"
#endif

/* 
 * Define the maximum k-mer length when
 * the compiler/make does not.
 */
#ifndef CONFIG_MAXKMERLENGTH
#define CONFIG_MAXKMERLENGTH 32
#endif

// some multipliers

/** something occuring twice is repeated */
#define REPEAT_MULTIPLIER 2

/** 3 standard deviations on both sides of a normal distribution include most points */
#define FRAGMENT_MULTIPLIER 3

#include <stdlib.h> /* for __WORDSIZE hopefully */
#include <stdint.h>

/* exit codes */

/*
 * Include those libraries for Microsoft Visual C++
 */
#ifdef _MSC_VER
#include <xiosbase>
#include <stdexcept>
/* http://msdn.microsoft.com/en-us/library/b0084kay%28VS.80%29.aspx */
#define __func__ __FUNCTION__ 
#endif

#ifdef CONFIG_FORCE_PACKING
/*
 * With gcc, one can pack data structures.
 */
	#ifdef __GNUC__
		#define ATTRIBUTE_PACKED  __attribute__ ((packed))
/*
 * For Microsoft Visual C++
 */
	#elif defined(_MSC_VER)
		#define ATTRIBUTE_PACKED /* sorry, not available yet */
	#else
		#define ATTRIBUTE_PACKED
	#endif
#else
	#define ATTRIBUTE_PACKED
#endif

#define DUMMY_LIBRARY 40000

#define RAY_NUCLEOTIDE_A 0 /* ~00 == 11 */
#define RAY_NUCLEOTIDE_C 1 /* ~01 == 10 */
#define RAY_NUCLEOTIDE_G 2 /* ~10 == 01 */
#define RAY_NUCLEOTIDE_T 3 /* ~11 == 00 */

#define SYMBOL_A 'A'
#define SYMBOL_T 'T'
#define SYMBOL_G 'G'
#define SYMBOL_C 'C'

#define SYMBOL_LOWER_A 'a'
#define SYMBOL_LOWER_T 't'
#define SYMBOL_LOWER_G 'g'
#define SYMBOL_LOWER_C 'c'

#define DOUBLE_ENCODING_A_COLOR '0'
#define DOUBLE_ENCODING_C_COLOR '1'
#define DOUBLE_ENCODING_G_COLOR '2'
#define DOUBLE_ENCODING_T_COLOR '3'

/* maximum value for a uint16_t */
#define RAY_MAXIMUM_READ_LENGTH 65535 

#define MAX_VERTICES_TO_VISIT 500
#define TIP_LIMIT 40

/*
 * this is the type used to store coverage values
 *
 * possible values are:
 *
 * - uint8_t for coverage values from 0 to 256-1
 * - uint16_t for coverage values from 0 to 65536-1
 * - uint32_t for coverage values from 0 to 4294967296-1
 *
 *
 */

#ifndef CONFIG_MAXIMUM_COVERAGE
	#define CONFIG_MAXIMUM_COVERAGE 99999
#endif


#if CONFIG_MAXIMUM_COVERAGE < 256
	typedef uint8_t CoverageDepth ;
#elif CONFIG_MAXIMUM_COVERAGE < 65536
	typedef uint16_t CoverageDepth;
#elif CONFIG_MAXIMUM_COVERAGE < 4294967296
	typedef uint32_t CoverageDepth;
#else
	typedef uint64_t CoverageDepth;
#endif

/** 32-bit or 64-bit system */

#if defined(__WORDSIZE)
/** use __WORDSIZE */
#define NUMBER_OF_BITS __WORDSIZE

#elif defined(_WIN64)

#define NUMBER_OF_BITS 64

#elif defined (_WIN32)

#define NUMBER_OF_BITS 32


/** assume 64 bits */
/* you may get some compilation warnings about printf and fprintf */
#else

#define NUMBER_OF_BITS 64

#endif

/* 64-bit system */
#if NUMBER_OF_BITS == 64
#define RAY_64_BITS

/* 32-bit system */
#elif NUMBER_OF_BITS == 32
#define RAY_32_BITS

/* assume a 64-bit system */
#else
#define RAY_64_BITS
#endif

/* since Lustre is not very good at caching file input/output operations
 * Ray agglomerates these operations */

#define SIZE_1M 1048576
#define SIZE_2M 2097152
#define SIZE_4M 4194304
#define SIZE_8M 8388608
#define SIZE_16M 16777216
#define SIZE_32M 33554432
#define SIZE_64M 67108864
#define SIZE_128M 134217728

#define CONFIG_FILE_IO_BUFFER_SIZE SIZE_16M

/* a DNA strand */
typedef char Strand;

/* a datatype for counts */
typedef uint64_t LargeCount;

/* a datatype for an index */
typedef uint64_t LargeIndex;

typedef uint16_t LibraryHandle;


typedef int SampleIdentifier;


/*
 * path storage engine
 * CONFIG_PATH_STORAGE_DEFAULT uses arrays of vertices, which consumes memory a lot.
 * CONFIG_PATH_STORAGE_BLOCK uses a block approach for vertices.
 */
#define CONFIG_PATH_STORAGE_BLOCK
//#define CONFIG_PATH_STORAGE_DEFAULT

#define BITS_PER_NUCLEOTIDE 2
#define BITS_PER_BYTE 8

#endif