Update to 2.0.0 tree from current Fremantle build
[opencv] / 3rdparty / flann / util / saving.h
1 /***********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright 2008-2009  Marius Muja (mariusm@cs.ubc.ca). All rights reserved.
5  * Copyright 2008-2009  David G. Lowe (lowe@cs.ubc.ca). All rights reserved.
6  *
7  * THE BSD LICENSE
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *************************************************************************/
30
31 #ifndef SAVING_H_
32 #define SAVING_H_
33
34 #include "constants.h"
35 #include "nn_index.h"
36
37
38 namespace flann
39 {
40
41 /**
42  * Structure representing the index header.
43  */
44 struct IndexHeader
45 {
46         char signature[16];
47         int flann_version;
48         flann_algorithm_t index_type;
49         int rows;
50         int cols;
51 };
52
53 /**
54  * Saves index header to stream
55  *
56  * @param stream - Stream to save to
57  * @param index - The index to save
58  */
59 void save_header(FILE* stream, const NNIndex& index);
60
61
62 /**
63  *
64  * @param stream - Stream to load from
65  * @return Index header
66  */
67 IndexHeader load_header(FILE* stream);
68
69
70 template<typename T>
71 void save_value(FILE* stream, const T& value, int count = 1)
72 {
73         fwrite(&value, sizeof(value),count, stream);
74 }
75
76
77 template<typename T>
78 void load_value(FILE* stream, T& value, int count = 1)
79 {
80         int read_cnt = fread(&value, sizeof(value),count, stream);
81         if (read_cnt!=count) {
82                 throw FLANNException("Cannot read from file");
83         }
84 }
85 }
86
87 #endif /* SAVING_H_ */