Blame view

tools/maca/libmaca/conv/fold.h 2.76 KB
Jan Lupa authored
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
/*
    Copyright (C) 2010 Tomasz Śniatowski, Adam Radziszewski
    Part of the libmaca project

    This program is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 3 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 LICENSE.MACA, LICENSE.SFST, LICENSE.GUESSER, COPYING.LESSER and COPYING files for more details.
*/

#ifndef LIBMACA_CONV_FOLD_H
#define LIBMACA_CONV_FOLD_H

#include <vector>
#include <boost/function.hpp>

namespace Corpus2 {
	class Token;
}

namespace Maca {
namespace Conversion {

/**
 * Helper function to find the shortest path -- the shortest vector
 * among the vectors passed.
 * @returns the shortest vector length
 * @param v the path vector
 * @param min_len_path output parameter where the index of the shortest
 *                     path is put
 */
size_t find_shortest(const std::vector<std::vector<Corpus2::Token *> >& v,
		size_t& min_len_path);

/**
 * Attempt path folding.
 *
 * Paths can be folded if:
 * - all have the same length
 * - all tokens at respective positions in each path have the same orth
 * If this is not the case, the function returns false and the input
 * vector is not modified. Otherwise all paths are merged tokenwise and
 * the resulting tokens are fed to the sink function object. All tokens
 * not fed to the sink are disposed of in that case.
 */
bool try_fold_paths(const std::vector< std::vector<Corpus2::Token*> >& v,
					boost::function<void (Corpus2::Token*)> sink);

/**
 * Discard all paths' tokens except for the path with the given index,
 * and feed the remaining path's tokens to the sink function object.
 */
std::vector<Corpus2::Token*> choose_path(
		const std::vector< std::vector<Corpus2::Token*> >& v, size_t n);

/**
 * Discard all paths' tokens except for the path with the given index,
 * and return the remaining path.
 */
void choose_path(const std::vector< std::vector<Corpus2::Token*> >& v, size_t n,
		boost::function<void (Corpus2::Token*)> sink);

/**
 * Find the shortest pathin the paths vector and return it, and dispose
 * of the other paths' tokens.
 */
std::vector<Corpus2::Token*> choose_shortest_path(
		const std::vector< std::vector<Corpus2::Token*> >& v);

/**
 * Find the shortest pathin the paths vector and feed its tokens to the
 * sink function, and delete other paths' tokens
 */
void choose_shortest_path(const std::vector< std::vector<Corpus2::Token*> >& v,
		boost::function<void (Corpus2::Token*)> sink);

} /* end ns Conversion */
} /* end ns Maca */

#endif // LIBMACA_CONV_FOLD_H