File: GraphSearchResult.h

package info (click to toggle)
ray 2.3.1-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,008 kB
  • sloc: cpp: 49,973; sh: 339; makefile: 281; python: 168
file content (89 lines) | stat: -rw-r--r-- 2,386 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
/*
 *  Ray -- Parallel genome assemblies for parallel DNA sequencing
 *  Copyright (C) 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 GraphSearchResult_Header
#define GraphSearchResult_Header

#include <code/SeedingData/PathHandle.h>
#include <code/SeedingData/GraphPath.h>

#include <RayPlatform/store/CarriageableItem.h>

#include <vector>
using namespace std;

/**
 * This stores a graph search result.
 *
 *     Path0  ---------->  Path1  ------> Path2   ------->  Path3
 *
 *     start              start         start               start
 *
 *        end                end             end                end
 *
 *
 * There are:
 *
 * * N m_pathNames
 * * N-1 m_computedPaths
 * * N m_pathStarts
 * * N m_pathEnds
 *
 * if start > end, it means that we must use the other DNA strand.
 *
 * \author Sébastien Boisvert
 */
class GraphSearchResult: public CarriageableItem {

	vector<PathHandle> m_pathHandles;
	vector<bool> m_pathOrientations; // false is normal, true is reverse
	vector<GraphPath> m_computedPaths;

	bool hasPath(PathHandle & handle);

public:

	bool addPathHandle(PathHandle handle, bool orientation);
	bool addPath(GraphPath & path);

	void print();

	int load(const char * buffer);
	int dump(char * buffer) const;
	int getRequiredNumberOfBytes() const;

	vector<PathHandle> & getPathHandles();
	vector<bool> & getPathOrientations();
	vector<GraphPath> & getComputedPaths();

	bool addPathOnLeftSide(PathHandle & handle, bool strand, GraphPath & path);
	bool addPathOnRightSide(PathHandle & handle, bool strand, GraphPath & path);

	string toString() const;

	/**
	 * Rotate the object to obtain a reverse-complement.
	 */
	void reverseContent();

	bool hasData() const;
};

#endif /* GraphSearchResult_Header */