Browse Source

Update READMEs

master
Jacob Still 1 year ago
parent
commit
314efbffea
  1. 1
      List/README.md
  2. 1
      Queue/README.md
  3. 9
      README.md
  4. 1
      Stack/README.md
  5. 127
      String/README.md
  6. 1
      Vector/README.md

1
List/README.md

@ -1,3 +1,4 @@
# List
Doubly linked list.
Tested with no known memory leaks or errors.

1
Queue/README.md

@ -1,3 +1,4 @@
# Queue
Queue implemented as a linked list.
Tested with no known memory leaks or errors.

9
README.md

@ -1,22 +1,29 @@
# Simplified C++ Containers
This is a simplified version of the STL containers.
This is a simplified version of the STL containers.
## List
Doubly linked list.
Tested with no known memory leaks or errors.
## Queue
Queue implemented as a linked list.
Tested with no known memory leaks or errors.
## Stack
Stack implemented as a linked list.
Contains memory leaks, but no known errors.
## String
String implemented using List.h <char>.
Tested with no known memory leaks or errors.
**This class should be a drop-in replacement for std::string**
## Vector
Vector implemented with dynamic arrays.
Contains memory leaks, but no known errors.

1
Stack/README.md

@ -1,3 +1,4 @@
# Stack
Stack implemented as a linked list.
Contains memory leaks, but no known errors.

127
String/README.md

@ -1,3 +1,130 @@
# String
String implemented using List.h <char>.
Tested with no known memory leaks or errors.
**This class should be a drop-in replacement for std::string**
## Public Member Functions:
* Note that most functions should perform just as their std::string counterparts
### Constructor
String();
### Destructor
~String();
### Overloaded operators
operator=
operator+=
operator[]
operator>>
operator<<
operator+
operator==
operator!=
operator<
operator<=
operator>
operator>=
swap
getline
### Capacity and sizing functions
sizeOf
length
resize
capacityOf
reserve
clear
isEmpty
shrink_to_fit
### Element access
at
back
front
### Modifiers
append
push_back
assign
insert
erase
replace
swap
pop_back
### String Operations
c_str
data
copy
find
rfind
find_first_of
find_last_of
find_first_not_of
find_last_not_of
substr
compare
### Conversion Functions
to_String
Stoi
Stou
Stol
Stoul
Stoull
Stof
Stod
Stold
### Other
print - Useful for debugging

1
Vector/README.md

@ -1,3 +1,4 @@
# Vector
Vector implemented with dynamic arrays.
Contains memory leaks, but no known errors.
Loading…
Cancel
Save