matrix.h

00001 /***********************************************************************
00002  * Software License Agreement (BSD License)
00003  *
00004  * Copyright 2008-2009  Marius Muja (mariusm@cs.ubc.ca). All rights reserved.
00005  * Copyright 2008-2009  David G. Lowe (lowe@cs.ubc.ca). All rights reserved.
00006  *
00007  * THE BSD LICENSE
00008  *
00009  * Redistribution and use in source and binary forms, with or without
00010  * modification, are permitted provided that the following conditions
00011  * are met:
00012  *
00013  * 1. Redistributions of source code must retain the above copyright
00014  *    notice, this list of conditions and the following disclaimer.
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in the
00017  *    documentation and/or other materials provided with the distribution.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00020  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00021  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00022  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00023  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00024  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00025  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00026  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00028  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *************************************************************************/
00030 
00031 #ifndef OPENCV_FLANN_DATASET_H_
00032 #define OPENCV_FLANN_DATASET_H_
00033 
00034 #include <stdio.h>
00035 
00036 #include "general.h"
00037 
00038 namespace cvflann
00039 {
00040 
00041 /**
00042  * Class that implements a simple rectangular matrix stored in a memory buffer and
00043  * provides convenient matrix-like access using the [] operators.
00044  */
00045 template <typename T>
00046 class Matrix
00047 {
00048 public:
00049     typedef T type;
00050 
00051     size_t rows;
00052     size_t cols;
00053     size_t stride;
00054     T* data;
00055 
00056     Matrix() : rows(0), cols(0), stride(0), data(NULL)
00057     {
00058     }
00059 
00060     Matrix(T* data_, size_t rows_, size_t cols_, size_t stride_ = 0) :
00061         rows(rows_), cols(cols_),  stride(stride_), data(data_)
00062     {
00063         if (stride==0) stride = cols;
00064     }
00065 
00066     /**
00067      * Convenience function for deallocating the storage data.
00068      */
00069     FLANN_DEPRECATED void free()
00070     {
00071         fprintf(stderr, "The cvflann::Matrix<T>::free() method is deprecated "
00072                 "and it does not do any memory deallocation any more.  You are"
00073                 "responsible for deallocating the matrix memory (by doing"
00074                 "'delete[] matrix.data' for example)");
00075     }
00076 
00077     /**
00078      * Operator that return a (pointer to a) row of the data.
00079      */
00080     T* operator[](size_t index) const
00081     {
00082         return data+index*stride;
00083     }
00084 };
00085 
00086 
00087 class UntypedMatrix
00088 {
00089 public:
00090     size_t rows;
00091     size_t cols;
00092     void* data;
00093     flann_datatype_t type;
00094 
00095     UntypedMatrix(void* data_, long rows_, long cols_) :
00096         rows(rows_), cols(cols_), data(data_)
00097     {
00098     }
00099 
00100     ~UntypedMatrix()
00101     {
00102     }
00103 
00104 
00105     template<typename T>
00106     Matrix<T> as()
00107     {
00108         return Matrix<T>((T*)data, rows, cols);
00109     }
00110 };
00111 
00112 
00113 
00114 }
00115 
00116 #endif //OPENCV_FLANN_DATASET_H_
00117