pcl: norms.h Source File

Go to the documentation of this file.
00001 /*
00002  * Software License Agreement (BSD License)
00003  *
00004  *  Point Cloud Library (PCL) - www.pointclouds.org
00005  *  Copyright (c) 2010, Willow Garage, Inc.
00006  *  Copyright (c) 2012-, Open Perception, Inc.
00007  *
00008  *  All rights reserved.
00009  *
00010  *  Redistribution and use in source and binary forms, with or without
00011  *  modification, are permitted provided that the following conditions
00012  *  are met:
00013  *
00014  *   * Redistributions of source code must retain the above copyright
00015  *     notice, this list of conditions and the following disclaimer.
00016  *   * Redistributions in binary form must reproduce the above
00017  *     copyright notice, this list of conditions and the following
00018  *     disclaimer in the documentation and/or other materials provided
00019  *     with the distribution.
00020  *   * Neither the name of the copyright holder(s) nor the names of its
00021  *     contributors may be used to endorse or promote products derived
00022  *     from this software without specific prior written permission.
00023  *
00024  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00025  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00026  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00027  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00028  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00029  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00030  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00031  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032  *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00033  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00034  *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00035  *  POSSIBILITY OF SUCH DAMAGE.
00036  *
00037  */
00038 
00039 #ifndef PCL_COMMON_NORMS_H_
00040 #define PCL_COMMON_NORMS_H_
00041 
00049 namespace pcl
00050 {
00055   enum NormType {L1, L2_SQR, L2, LINF, JM, B, SUBLINEAR, CS, DIV, PF, K, KL, HIK};
00056 
00061   template <typename FloatVectorT> inline float
00062   selectNorm (FloatVectorT A, FloatVectorT B, int dim, NormType norm_type);
00063 
00071   template <typename FloatVectorT> inline float
00072   L1_Norm (FloatVectorT A, FloatVectorT B, int dim);
00073   
00081   template <typename FloatVectorT> inline float
00082   L2_Norm_SQR (FloatVectorT A, FloatVectorT B, int dim);
00083   
00091   template <typename FloatVectorT> inline float
00092   L2_Norm (FloatVectorT A, FloatVectorT B, int dim);
00093 
00101   template <typename FloatVectorT> inline float
00102   Linf_Norm (FloatVectorT A, FloatVectorT B, int dim);
00103 
00111   template <typename FloatVectorT> inline float
00112   JM_Norm (FloatVectorT A, FloatVectorT B, int dim);
00113 
00121   template <typename FloatVectorT> inline float
00122   B_Norm (FloatVectorT A, FloatVectorT B, int dim);
00123 
00131   template <typename FloatVectorT> inline float
00132   Sublinear_Norm (FloatVectorT A, FloatVectorT B, int dim);
00133 
00141   template <typename FloatVectorT> inline float
00142   CS_Norm (FloatVectorT A, FloatVectorT B, int dim);
00143 
00151   template <typename FloatVectorT> inline float
00152   Div_Norm (FloatVectorT A, FloatVectorT B, int dim);
00153 
00163   template <typename FloatVectorT> inline float
00164   PF_Norm (FloatVectorT A, FloatVectorT B, int dim, float P1, float P2);
00165 
00175   template <typename FloatVectorT> inline float
00176   K_Norm (FloatVectorT A, FloatVectorT B, int dim, float P1, float P2);
00177 
00185   template <typename FloatVectorT> inline float
00186   KL_Norm (FloatVectorT A, FloatVectorT B, int dim);
00187 
00195   template <typename FloatVectorT> inline float
00196   HIK_Norm (FloatVectorT A, FloatVectorT B, int dim);
00197 }
00199 #include <pcl/common/impl/norms.hpp>
00200 
00201 #endif  //#ifndef PCL_NORMS_H_