From fb004677196801b89ac13eb5537847a85dc8bb14 Mon Sep 17 00:00:00 2001 From: Syndamia Date: Tue, 14 Jun 2022 15:21:30 +0300 Subject: Added documentation --- docs/html/List_8hpp.html | 180 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 180 insertions(+) create mode 100644 docs/html/List_8hpp.html (limited to 'docs/html/List_8hpp.html') diff --git a/docs/html/List_8hpp.html b/docs/html/List_8hpp.html new file mode 100644 index 0000000..ef7295e --- /dev/null +++ b/docs/html/List_8hpp.html @@ -0,0 +1,180 @@ + + + + + + + +FMI Table: src/Generic/List/List.hpp File Reference + + + + + + + + + +
+
+ + + + + + +
+
FMI Table +
+
| Kamen Mladenov | FMI Computer Science Year 1 Group 6 | Project 2 | Project Topic 7 |
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+ +
List.hpp File Reference
+
+
+ +

Stores declaration and definition of templated class List. +More...

+
#include <istream>
+#include <ostream>
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  List< T >
 Templated class that stores an array of elements in dynamic memory. More...
 
+ + + + + + + + + +

+Functions

template<typename T >
std::istream & operator>> (std::istream &istr, List< T > &obj)
 Reads List from stream with >> operator. More...
 
template<typename T >
std::ostream & operator<< (std::ostream &ostr, const List< T > &obj)
 Writes List to stream with << operator. More...
 
+

Detailed Description

+

Stores declaration and definition of templated class List.

+

Function Documentation

+ +

◆ operator<<()

+ +
+
+
+template<typename T >
+ + + + + + + + + + + + + + + + + + +
std::ostream & operator<< (std::ostream & ostr,
const List< T > & obj 
)
+
+ +

Writes List to stream with << operator.

+

Uses the stream's << operator to write the count and then all objects.

+
Warning
The function depends on the type having the operator << defined, which takes an std::ostream& and writes it's data to it. Return type doesn't matter.
+
Note
Best used with std::cout or text std::ofstream
+ +
+
+ +

◆ operator>>()

+ +
+
+
+template<typename T >
+ + + + + + + + + + + + + + + + + + +
std::istream & operator>> (std::istream & istr,
List< T > & obj 
)
+
+ +

Reads List from stream with >> operator.

+

Uses the stream's >> operator to read and parse the elements. The first item in the stream should be the count.

+
Warning
The function depends on the type having the operator >> defined, which takes an std::istream& and writes it's data to it. Return type doesn't matter.
+
Note
Best used with std::cin or text std::ifstream
+ +
+
+
+ + + + -- cgit v1.3.1-26-gb76a