From e2bbe047e4b18d1957618d70d9081143051c5add Mon Sep 17 00:00:00 2001
From: Nina Dzugasova <dzugasova.nina@gmail.com>
Date: Fri, 19 Oct 2018 16:44:18 +0200
Subject: [PATCH] Added documentation of String. Found error in StringTest
split function.
---
src/TNL/DistributedContainers/Subrange.h | 1 -
.../Linear/Preconditioners/Preconditioner.h | 2 +
src/TNL/String.h | 101 +++++++++++-------
src/UnitTests/StringTest.cpp | 8 ++
4 files changed, 74 insertions(+), 38 deletions(-)
diff --git a/src/TNL/DistributedContainers/Subrange.h b/src/TNL/DistributedContainers/Subrange.h
index 1512bd2eea..e581c9a4fc 100644
--- a/src/TNL/DistributedContainers/Subrange.h
+++ b/src/TNL/DistributedContainers/Subrange.h
@@ -13,7 +13,6 @@
#pragma once
#include <ostream>
-
#include <TNL/Assert.h>
#include <TNL/String.h>
#include <TNL/param-types.h>
diff --git a/src/TNL/Solvers/Linear/Preconditioners/Preconditioner.h b/src/TNL/Solvers/Linear/Preconditioners/Preconditioner.h
index 8d294bd8ae..58ab8c682b 100644
--- a/src/TNL/Solvers/Linear/Preconditioners/Preconditioner.h
+++ b/src/TNL/Solvers/Linear/Preconditioners/Preconditioner.h
@@ -17,6 +17,8 @@
#include <TNL/Config/ParameterContainer.h>
#include <TNL/Solvers/Linear/Traits.h>
+#include "../Traits.h"
+
namespace TNL {
namespace Solvers {
namespace Linear {
diff --git a/src/TNL/String.h b/src/TNL/String.h
index 2d3d89af98..b902be6759 100644
--- a/src/TNL/String.h
+++ b/src/TNL/String.h
@@ -26,30 +26,33 @@ template< typename T >
String convertToString( const T& value );
/////
-// \brief Class for managing strings
+// \brief Class for managing strings.
class String
{
public:
/////
- /// \brief Basic constructor
+ /// \brief Basic constructor. Constructs an empty string object, with the length of zero characters.
String();
/////
/// \brief Constructor with char pointer.
- /// Constructor with char pointer.
- /// @param prefix_cut_off says length of the prefix that is going to be omitted and
- /// @param sufix_cut_off says the same about suffix.
+ /// Copies the null-terminated character sequence (C-string) pointed by \e c.
+ /// Constructs a string initialized with the 8-bit string \e c, excluding the given number of \e prefix_cut_off and \e sufix_cut_off characters.
+ /// @param prefix_cut_off determines the length of the prefix that is going to be omitted from the string \e c
+ /// @param sufix_cut_off determines the length of the sufix that is going to be omitted from the string \e c
String( const char* c,
int prefix_cut_off = 0,
int sufix_cut_off = 0 );
+ /// Returns type of string - String.
static String getType();
- //! Copy constructor
+ /////
+ /// \brief Copy constructor. Constructs a copy of the string \e str.
String( const String& str );
- //! Convert anything to a string
+ /// \brief Converts anything to a string.
template< typename T >
explicit
String( T value )
@@ -58,106 +61,130 @@ class String
setString( convertToString( value ).getString() );
}
- //! Destructor
+ /// \brief Destructor.
~String();
- //! Return length of the string
+ /// Returns the number of characters in given string. Equivalent to \c getSize().
int getLength() const;
+ /// Returns the number of characters in given string.
int getSize() const;
- //! Return currently allocated size
+ /// Returns size of allocated storage for given string.
int getAllocatedSize() const;
- //! Reserve space for given number of characters
+ /// Reserves space for given number of characters (\e size).
+ /// Requests to allocate storage for given \e size (number of characters).
void setSize( int size );
- //! Set string from given char pointer
- /*! @param prefix_cut_off says length of the prefix that is going to be omitted and
- @param sufix_cut_off says the same about sufix.
- */
+ /////
+ /// Sets string from given char pointer \e c.
+ /// @param prefix_cut_off determines the length of the prefix that is going to be omitted from the string \e c
+ /// @param sufix_cut_off determines the length of the sufix that is going to be omitted from the string \e c
void setString( const char* c,
int prefix_cut_off = 0,
int sufix_cut_off = 0 );
- //! Return pointer to data
+ /// Returns pointer to data. It returns the content of the given string.
const char* getString() const;
- //! Return pointer to data
+ /// Returns pointer to data.
char* getString();
- //! Operator for accesing particular chars of the string
+ /// \brief Operator for accesing particular chars of the string. This function overloads operator[](). It returns a reference to the character at position \e i in given string.
const char& operator[]( int i ) const;
- //! Operator for accesing particular chars of the string
+ /// \brief Operator for accesing particular chars of the string. It returns the character at the position \e i in given string as a modifiable reference.
char& operator[]( int i );
- /****
- * Operators for C strings
- */
+ /////
+ /// \brief Operators for C strings.
+ /// This function overloads operator=(). It assigns \e str to this string, replacing its current contents.
String& operator=( const char* str );
+ /// This function overloads operator+=(). It appends the string \e str to this string.
String& operator+=( const char* str );
+ /// This function concatenates strings and returns a newly constructed string object.
String operator+( const char* str ) const;
+ /// This function overloads operator==().
bool operator==( const char* str ) const;
+ /// This function overloads operator!=().
bool operator!=( const char* str ) const;
- /****
- * Operators for Strings
- */
+ /////
+ /// \brief Operators for Strings.
+ /// This function assigns \e str to this string and returns a reference to this string.
String& operator=( const String& str );
+ /// This function appends the string \e str onto the end of this string and returns a reference to this string.
String& operator+=( const String& str );
+ /// This function concatenates strings and returns a newly constructed string object.
String operator+( const String& str ) const;
+ /// This function overloads operator==(). It returns \c true if this string is equal to \e str, otherwise returns \c false.
bool operator==( const String& str ) const;
+ /// This function overloads operator!=(). It returns \c true if this string is not equal to \e str, otherwise returns \c false.
bool operator!=( const String& str ) const;
- /****
- * Operators for single characters
- */
+ /////
+ /// \brief Operators for single characters.
+ /// This function overloads operator=(). It assigns character /e str to this string.
String& operator=( char str );
+ /// This function overloads operator+=(). It appends character /e str to this string.
String& operator+=( char str );
+ // This function concatenates strings and returns a newly constructed string object.
String operator+( char str ) const;
+ // This function concatenates strings and returns a newly constructed string object.
bool operator==( char str ) const;
+ /// This function overloads operator!=().
bool operator!=( char str ) const;
- //! Cast to bool operator
+ /// \brief Cast to bool operator.
operator bool() const;
- //! Cast to bool with negation operator
+ /// \brief Cast to bool with negation operator.
bool operator!() const;
+ /////
+ /// \brief Replaces portion of string.
+ ///It replaces section \e pattern from this string with new piece of string \e replaceWith.
+ ///If parameter \e count is defined, the function makes replacement several times, every time when it finds the same pattern in this string.
String replace( const String& pattern,
const String& replaceWith,
int count = 0 ) const;
+ /// \brief Trims/strips given string. It removes all spaces from string except for single spaces between words.
String strip( char strip = ' ' ) const;
- //! Split the string into list of strings w.r.t. given separator.
+ /// \brief Splits string into list of strings with respect to given \e separator.
+ /// It splits the string into list of substrings wherever \e separator occurs, and returs list of those strings.
+ /// When \e separator does not appear anywhere in the given string, this function returns a single-element list containing given sting.
+ /// @param separator Character, which separates substrings in given string. Empty character can not be used.
int split( Containers::List< String >& list, const char separator = ' ' ) const;
- //! Write to a binary file
+ /// Write to a binary file
bool save( File& file ) const;
- //! Read from binary file
+ /// Read from binary file
bool load( File& file );
//! Broadcast to other nodes in MPI cluster
- // void MPIBcast( int root, MPI_Comm mpi_comm = MPI_COMM_WORLD );
+ // void MPIBcast( int root, MPI_Comm mpi_comm = MPI_COMM_WORLD );
- //! Read one line from given stream.
+ /// Read one line from given stream.
bool getLine( std::istream& stream );
friend std::ostream& operator<<( std::ostream& stream, const String& str );
protected:
- //! Pointer to char ended with zero
+ /// Pointer to char ended with zero
char* string;
- //! Length of the allocated piece of memory
+ /// Length of the allocated piece of memory
int length;
};
+/// Returns concatenation of \e string1 and \e string2.
String operator+( char string1, const String& string2 );
+/// Returns concatenation of \e string1 and \e string2.
String operator+( const char* string1, const String& string2 );
std::ostream& operator<<( std::ostream& stream, const String& str );
diff --git a/src/UnitTests/StringTest.cpp b/src/UnitTests/StringTest.cpp
index 4c1f1dcc92..f6664673ec 100644
--- a/src/UnitTests/StringTest.cpp
+++ b/src/UnitTests/StringTest.cpp
@@ -308,6 +308,14 @@ TEST( StringTest, split )
String( "abracadabra" ).split( list, 'A' );
ASSERT_EQ( list.getSize(), 1 );
EXPECT_EQ( list[ 0 ], "abracadabra" );
+
+ /// !!!!
+ String( "a,,b,c" ).split( list, ',' );
+ ASSERT_EQ( list.getSize(), 4 );
+ EXPECT_EQ( list[ 0 ], "a" );
+ EXPECT_EQ( list[ 1 ], "" );
+ EXPECT_EQ( list[ 2 ], "b" );
+ EXPECT_EQ( list[ 3 ], "c" );
}
TEST( StringTest, SaveLoad )
--
GitLab