初始化提交
This commit is contained in:
81
arduino-cli/libraries/QList-master/README.md
Normal file
81
arduino-cli/libraries/QList-master/README.md
Normal file
@@ -0,0 +1,81 @@
|
||||
<p align="center"><img src="logo.png" alt="QList" height="200px"></p>
|
||||
|
||||
# QList
|
||||
[](https://travis-ci.org/SloCompTech/QList)
|
||||
[]()
|
||||
|
||||
Linked list library for Arduino
|
||||
|
||||
Purpose of this library is to enable programmers to create lists of things
|
||||
|
||||
Before we can start using library, we need to include library to our sketch
|
||||
``` C++
|
||||
#include <QList.h>
|
||||
```
|
||||
|
||||
First, we create simple list object example for ints:
|
||||
``` C++
|
||||
QList<int> list;
|
||||
```
|
||||
|
||||
Then we can add items in list:
|
||||
``` C++
|
||||
list.push_front(item); // Push item at the front of the list
|
||||
list.push_back(item); // Push item at the back of the list
|
||||
```
|
||||
|
||||
Items on the list can be removed:
|
||||
``` C++
|
||||
list.pop_front(); // Remove item at the front of the list
|
||||
list.pop_back(); // Remove item at the back of the list
|
||||
/*
|
||||
Remove item at given position
|
||||
WARNING !
|
||||
Note:
|
||||
- index starts with 0 not 1 so interval is [0,n)
|
||||
- always check if index is in valid range before you try to clear item
|
||||
*/
|
||||
list.clear(index);
|
||||
|
||||
list.clear(); // This removes ALL items from list
|
||||
```
|
||||
Items on the list can accessed:
|
||||
``` C++
|
||||
int val1 = list.front(); // Get item at the front of the list
|
||||
int val2 = list.back(); // Get item at the back of the list
|
||||
/*
|
||||
Get item at given position
|
||||
WARNING !
|
||||
Note:
|
||||
- index starts with 0 not 1 so interval is [0,n)
|
||||
- always check if index is in valid range before you try to get item
|
||||
*/
|
||||
int val3 = list.at(index);
|
||||
int val3 = list.get(index);
|
||||
int val3 = list[index];
|
||||
```
|
||||
|
||||
Values of items that are already in the list, can be changed:
|
||||
``` C++
|
||||
/*
|
||||
WARNING !
|
||||
Note:
|
||||
- always check if index is in valid range before you try to change value of item
|
||||
*/
|
||||
list.at(index) = 3;
|
||||
list[index] = 3; // Same as above
|
||||
```
|
||||
|
||||
Size of list can be accessed with:
|
||||
``` C++
|
||||
int list_size = list.size();
|
||||
int same_list_size = list.length();
|
||||
```
|
||||
|
||||
You can also search for items in list:
|
||||
``` C++
|
||||
int pos = list.indexOf(item);
|
||||
if(pos < 0)
|
||||
Serial.println("Item not found");
|
||||
```
|
||||
Note: If item is not found function returns -1
|
||||
Reference in New Issue
Block a user