Line data    Source code

       1              : /*
       2              :  * Copyright (c) 2012-2015:  G-CSC, Goethe University Frankfurt
       3              :  * Author: Sebastian Reiter
       4              :  * 
       5              :  * This file is part of UG4.
       6              :  * 
       7              :  * UG4 is free software: you can redistribute it and/or modify it under the
       8              :  * terms of the GNU Lesser General Public License version 3 (as published by the
       9              :  * Free Software Foundation) with the following additional attribution
      10              :  * requirements (according to LGPL/GPL v3 §7):
      11              :  * 
      12              :  * (1) The following notice must be displayed in the Appropriate Legal Notices
      13              :  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
      14              :  * 
      15              :  * (2) The following notice must be displayed at a prominent place in the
      16              :  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
      17              :  * 
      18              :  * (3) The following bibliography is recommended for citation and must be
      19              :  * preserved in all covered files:
      20              :  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
      21              :  *   parallel geometric multigrid solver on hierarchically distributed grids.
      22              :  *   Computing and visualization in science 16, 4 (2013), 151-164"
      23              :  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
      24              :  *   flexible software system for simulating pde based models on high performance
      25              :  *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
      26              :  * 
      27              :  * This program is distributed in the hope that it will be useful,
      28              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      29              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
      30              :  * GNU Lesser General Public License for more details.
      31              :  */
      32              : 
      33              : #ifndef __H__UG__vector_util__
      34              : #define __H__UG__vector_util__
      35              : 
      36              : #include <vector>
      37              : 
      38              : namespace ug
      39              : {
      40              : 
      41              : /// \addtogroup ugbase_common_util
      42              : /// \{
      43              : 
      44              : ///     Returns a pointer to the array which is managed by the std::vector.
      45              : /**     Note that this pointer may be invalidated once new elements are added
      46              :  * to the vector or old ones are removed.
      47              :  *
      48              :  * The method returns NULL if the vector is empty.
      49              :  * \{ */
      50              : template <class T>
      51              : T* GetDataPtr(std::vector<T>& v)
      52              : {
      53            0 :         if(v.empty())
      54            0 :                 return NULL;
      55              :         return &v.front();
      56              : }
      57              : 
      58              : template <class T>
      59              : const T* GetDataPtr(const std::vector<T>& v)
      60              : {
      61            0 :         if(v.empty())
      62            0 :                 return NULL;
      63              :         return &v.front();
      64              : }
      65              : /**     \} */
      66              : 
      67              : // end group ugbase_common_util
      68              : /// \}
      69              : 
      70              : }//     end of namespace
      71              : 
      72              : #endif