Skip to content

Commit

Permalink
Updates on readme with new stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
spirosmaggioros committed Sep 3, 2024
1 parent 3253b18 commit 3980968
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/macos_test_cases.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This starter workflow is for a CMake project running on a single platform. There is a different starter workflow if you need cross-platform coverage.
# See: https://github.com/actions/starter-workflows/blob/main/ci/cmake-multi-platform.yml
name: macos-test-cases
name: macos-tests

on:
push:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ubuntu_test_cases.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: ubuntu-test-cases
name: ubuntu-tests

on:
push:
Expand Down
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ AlgoPlus is a C++ library that includes ready-to-use complex **data structures**
![Algoplus](https://github.com/CSRT-NTUA/AlgoPlus/blob/main/assets/logo.png)

[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/CSRT-NTUA/AlgoPlus)
![macos-tests](https://github.com/CSRT-NTUA/AlgoPlus/actions/workflows/macos_test_cases.yml/badge.svg)
![ubuntu-tests](https://github.com/CSRT-NTUA/AlgoPlus/actions/workflows/ubuntu_test_cases.yml/badge.svg)
[![CodeQL CI](https://github.com/TheAlgorithms/C-Plus-Plus/actions/workflows/codeql.yml/badge.svg)](https://github.com/CSRT-NTUA/AlgoPlus/actions/workflows/codeql.yml)
[![codecov](https://codecov.io/gh/CSRT-NTUA/AlgoPlus/graph/badge.svg?token=3SBDRHUQR5)](https://codecov.io/gh/CSRT-NTUA/AlgoPlus)
![GitHub repo size](https://img.shields.io/github/repo-size/CSRT-NTUA/AlgoPlus)
Expand All @@ -16,16 +18,19 @@ AlgoPlus is a C++ library that includes ready-to-use complex **data structures**
### Example:

```cpp
#include <machine_learning/clustering/kmeans/kmeans.h>
#include <machine_learning/clustering/DBSCAN/dbscan.h>

// AlgoPlus now has Machine Learning classes!
int main(){
std::vector<std::vector<double> > data;
int CLUSTERS;
kmeans a(data, CLUSTERS);
...
// returns the cluster centers and assignments of the kmeans clustering
std::pair<std::vector<std::vector<double> >, std::map<std::vector<double>, int64_t> > ans = a.fit();
// Eps = 4, MinPts = 3
DBSCAN a(data, 4, 3);

// returns the clusters and noise of the DBSCAN clustering
std::map<std::pair<double, double>, int64_t> clusters = a.get_clusters();
std::vector<std::pair<double, double> > noise = a.get_noise();
...
}

#include <machine_learning/image/edge_detection/sobel_operator.h>
Expand Down

0 comments on commit 3980968

Please sign in to comment.