DBInitializerFromCSV.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - 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,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_LEARNING_DB_INITILIALIZER_FROM_CSV_H
#define GUM_LEARNING_DB_INITILIALIZER_FROM_CSV_H
 
#include <fstream>
#include <iostream>
#include <sstream>
#include <string>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/database/CSVParser.h>
#include <agrum/base/database/IDBInitializer.h>
 
namespace gum {
 
  namespace learning {

    class GUM_SHARED_PUBLIC DBInitializerFromCSV: public IDBInitializer {
      public:
      // ##########################################################################
      // ##########################################################################


      DBInitializerFromCSV(const std::string filename,
                           bool              fileContainsNames = true,
                           const std::string delimiter         = ",",
                           const char        commentmarker     = '#',
                           const char        quoteMarker       = '"');


      DBInitializerFromCSV(const DBInitializerFromCSV& from);

      DBInitializerFromCSV(DBInitializerFromCSV&& from);

      [[nodiscard]] DBInitializerFromCSV* clone() const override;

      ~DBInitializerFromCSV() override;

 
 
      // ##########################################################################
      // ##########################################################################



      DBInitializerFromCSV& operator=(const DBInitializerFromCSV& from);


      DBInitializerFromCSV& operator=(DBInitializerFromCSV&& from);

 
 
      protected:
      std::vector< std::string > variableNames_() final;

      const std::vector< std::string >& currentStringRow_() final;

      bool nextRow_() final;
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
      private:
      // the filename used for parsing
      std::string _filename_;
 
      // indicates the delimiter used within the CSV
      std::string _delimiter_;
 
      // indicates which character is a comment symbol in the CSV
      char _comment_marker_;
 
      // indicates which character is a quote symbol in the CSV
      char _quote_marker_;
 
      // indicates whether the first row of the file contains the names
      bool _first_row_has_names_;
 
      // the input stream read by the parser
      std::ifstream _input_stream_;
 
      // the CSV parser used for the reading the CSV file
      CSVParser _parser_;
 
      // the variables names, if the first row has names
      std::vector< std::string > _var_names_;
 
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
    };
 
  } /* namespace learning */
 
} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/base/database/DBInitializerFromCSV_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_LEARNING_DB_INITILIALIZER_FROM_CSV_H */