Skip to content

Commit f9c0d46

Browse files
abranheabranhe
authored
create template
1 parent 470721f commit f9c0d46

File tree

1 file changed

+106
-0
lines changed
  • .github/category-template/algorithm-template

1 file changed

+106
-0
lines changed

‎.github/category-template/algorithm-template/readme.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Algorithm Name
2+
3+
<!-- REMOVE THIS -->
4+
> Be short, please don't copy the complete wikipedia page here.
5+
<!-- REMOVE THIS -->
6+
7+
<!-- REMOVE THIS -->
8+
Description
9+
<!-- REMOVE THIS -->
10+
11+
A bubble sort, a sorting algorithm that continuously steps through a list,
12+
swapping items until they appear in the correct order. The list was plotted
13+
in a Cartesian coordinate system, with each point (x, y) indicating that the value y is
14+
stored at index x. Then the list would be sorted by bubble sort according to every pixel's value.
15+
Note that the largest end gets sorted first, with smaller elements taking longer to move to their correct positions.
16+
17+
18+
## Performance
19+
20+
| Complexity | |
21+
| -------------------------- | ----------------------------------- |
22+
| Worst-case performance | О(n²) comparisons, О(n²) swaps |
23+
| Best-case performance | О(n) comparisons, О(1) swaps |
24+
| Average performance | О(n²) comparisons, О(n²) swaps |
25+
| Worst-case space complexity| O(1) auxiliary |
26+
27+
<!-- REMOVE THIS -->
28+
Example gif or image if exists.
29+
<!-- REMOVE THIS -->
30+
31+
![img](https://upload.wikimedia.org/wikipedia/commons/3/37/Bubble_sort_animation.gif)
32+
33+
34+
![img](https://upload.wikimedia.org/wikipedia/commons/c/c8/Bubble-sort-example-300px.gif)
35+
36+
<!-- REMOVE THIS -->
37+
Add some helpful link(s)
38+
<!-- REMOVE THIS -->
39+
40+
# Helpful Links
41+
42+
> You can also document yourself and learn more here
43+
44+
- Link to [External Docs]()
45+
- Link to [External Blog Post]()
46+
- Link to [Somewhere else]()
47+
48+
# Implementations
49+
50+
| Language | 👍 | Source | Run it Online |
51+
| :-------------------------------------------------------------------------------------------------------------------------------: | :-: | :--------------------------------------------: | :-----------------------: |
52+
| <img src="http://konpa.github.io/devicon/devicon.git/icons/c/c-original.svg" width="30px"> | ❌ | [algorithm.c](algorithm.c) | [Repl.it]() |
53+
| <img src="http://konpa.github.io/devicon/devicon.git/icons/cplusplus/cplusplus-original.svg" width="30px"> | ❌ |[algorithm.cpp](algorithm.cpp) | [Repl.it]() |
54+
| <img src="http://konpa.github.io/devicon/devicon.git/icons/java/java-original.svg" width="30px"> | ❌ |[algorithm.java](algorithm.java) | [Repl.it]() |
55+
| <img src="http://konpa.github.io/devicon/devicon.git/icons/python/python-original.svg" width="30px"> | ❌ |[algorithm.py](algorithm.py) | [Repl.it]() |
56+
| <img src="http://konpa.github.io/devicon/devicon.git/icons/javascript/javascript-original.svg" width="30px"> | ❌ |[algorithm.js](algorithm.js) | [Repl.it]() |
57+
| <img src="https://cdn-images-1.medium.com/max/600/1*FEE98iWinlZBYkxBAG8MvA.png" width="30px"> | ✅ |[algorithm.sh](algorithm.sh) | [Repl.it]() |
58+
| <img src="http://konpa.github.io/devicon/devicon.git/icons/php/php-original.svg" width="30px"> | ✅ |[algorithm.php](algorithm.php) | [Repl.it]() |
59+
| <img src="http://konpa.github.io/devicon/devicon.git/icons/ruby/ruby-original.svg" width="30px"> | ✅ |[algorithm.rb](algorithm.rb) | [Repl.it]() |
60+
| <img src="http://konpa.github.io/devicon/devicon.git/icons/swift/swift-original.svg" width="30px"> | ✅ |[algorithm.swift](algorithm.swift) | [Repl.it]() |
61+
| <img src="http://konpa.github.io/devicon/devicon.git/icons/go/go-original.svg" width="30px"> | ❌ |[algorithm.go](algorithm.go) | [Repl.it]() |
62+
| <img src="https://cdn.svgporn.com/logos/r-lang.svg" width="30px"> | ✅ |[algorithm.r](algorithm.r) | [Repl.it]() |
63+
| <img src="https://cdn.svgporn.com/logos/scala.svg" width="30px"> | ✅ |[algorithm.scala](algorithm.scala) | [Repl.it]() |
64+
| <img src="http://www.cappuccino-project.org/img/cappuccino-icon-8c7fb1dd.png" width="30px"> | ❌ |[algorithm.j](algorithm.j) | [Repl.it]() |
65+
| <img src="https://raw.githubusercontent.com/librariesio/pictogram/master/vendor/assets/images/fortran/fortran.png" width="30px"> | ❌ |[algorithm.f95](algorithm.f95) | [Repl.it]() |
66+
| <img src="https://cdn.abranhe.com/projects/algorithms/logos/brainfuck.svg" width="30px"> | ✅ |[algorithm.bf](algorithm.bf) | [Repl.it]() |
67+
| <img src="https://cdn.svgporn.com/logos/kotlin.svg" width="30px"> | ❌ |[algorithm.kt](algorithm.kt) | [Repl.it]() |
68+
| <img src="https://upload.wikimedia.org/wikipedia/commons/5/5d/Clojure_logo.svg" width="30px"> | ✅ |[algorithm.clj](algorithm.clj) | [Repl.it]() |
69+
| <img src="https://racket-lang.org/img/racket-logo.svg" width="30px"> | ❌ |[algorithm.m](example_source.m) | [Repl.it]() |
70+
| <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/4/4a/Maxima-new.svg/128px-Maxima-new.svg.png" width="30px"> | ❌ |[algorithm.rkt](algorithm.rkt) | [Repl.it]() |
71+
| <img src="http://www.lolcode.org/img/logo.png" width="30px"> | ✅ |[algorithm.lol](algorithm.lol) | [Repl.it]() |
72+
| <img src="https://upload.wikimedia.org/wikipedia/en/9/9e/AppleScript_Editor_Logo.png" width="30px"> | ❌ |[algorithm.applescript](algorithm.applescript) | [Repl.it]() |
73+
| <img src="https://cdn.svgporn.com/logos/erlang.svg" width="30px"> | ❌ |[algorithm.erl](algorithm.erl) | [Repl.it]() |
74+
| <img src="https://cdn.svgporn.com/logos/fsharp.svg" width="30px"> | ❌ |[algorithm.fsx](algorithm.fsx) | [Repl.it]() |
75+
| <img src="https://cdn.svgporn.com/logos/lua.svg" width="30px"> | ❌ |[algorithm.lua](algorithm.lua) | [Repl.it]() |
76+
| <img src="https://cdn.svgporn.com/logos/typescript-icon.svg" width="30px"> | ✅ |[algorithm.ts](algorithm.ts) | [Repl.it]() |
77+
| <img src="https://common-lisp.net/static/imgs/lisplogo.png" width="30px"> | ❌ |[algorithm.lisp](algorithm.lisp) | [Repl.it]() |
78+
| <img src="https://www.rust-lang.org/logos/rust-logo-blk.svg" width="30px"> | ❌ |[algorithm.rs](algorithm.rs) | [Repl.it]() |
79+
| <img src="https://cdn.abranhe.com/projects/algorithms/logos/assembly.svg" width="30px"> | ❌ |[algorithm.asm](algorithm.asm) | [Repl.it]() |
80+
| <img src="https://upload.wikimedia.org/wikipedia/commons/2/21/Matlab_Logo.png" width="30px"> | ✅ |[algorithm.m](algorithm.m) | [Repl.it]() |
81+
| <img src="https://cdn.svgporn.com/logos/perl.svg" width="30px"> | ❌ |[algorithm.pl](algorithm.pl) | [Repl.it]() |
82+
| <img src="https://julialang.org/v2/img/logo.svg" width="30px"> | ❌ |[algorithm.jl](algorithm.jl) | [Repl.it]() |
83+
| <img src="http://konpa.github.io/devicon/devicon.git/icons/csharp/csharp-original.svg" width="30px"> | ✅ |[algorithm.cs](algorithm.cs) | [Repl.it]() |
84+
| <img src="https://www.haskell.org/static/img/haskell-logo.svg" width="30px"> | ❌ |[algorithm.hs](algorithm.hs) | [Repl.it]() |
85+
86+
87+
# Github or External Libraries
88+
89+
<!--
90+
REMOVE THIS
91+
Follow the list style
92+
Add the link to the exact file where the algorith is implementned
93+
-->
94+
- Link to [External Library]()
95+
- Link to [Some Library]()
96+
- Link to [Example Library]()
97+
<!-- REMOVE THIS -->
98+
99+
# Videos
100+
101+
<!-- REMOVE THIS Follow the list style
102+
-->
103+
- Youtube [youtu.be/example]()
104+
- Vimeo [vimeo.com/example]()
105+
- Other [example.com/video]()
106+
<!-- REMOVE THIS -->

0 commit comments

Comments
 (0)