From ed4ce283fc70a8c373f8247257b3963b8d4a112a Mon Sep 17 00:00:00 2001 From: Brady McNeely Date: Sun, 11 Sep 2022 23:07:26 -0400 Subject: [PATCH 1/3] updated readme --- README.md | 41 ++++++++++++++++++++-------------- images/Good_Documentation.png | Bin 0 -> 15772 bytes 2 files changed, 24 insertions(+), 17 deletions(-) create mode 100644 images/Good_Documentation.png diff --git a/README.md b/README.md index cd08ee6c..bd9263d1 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,34 @@ # Data-Structures-and-Algorithms-in-cpp -This is very good piece of coding. -This repository is in development phase and will soon provide you with c++ code of various data structures and algorithms +This repository is in development phase and will soon provide you with C++ code of various data structures and algorithms. -## Who can contribute -Anyone can contribute to this repositry. +## What is this for? +This project is designed to be a reference for anyone needing to implement a particular data structure or algorithm into their C++ program. # Contribution Guide -## How to contribute - +## Who can contribute? +Anyone can contribute to this repository. -## Instructions -Create a folder for the topic you wish to contribute in and add the respective files in that particular folder. -If a folder for a particular Data Structure or Algorithm exists. Add your codes in that folder itself. -If a folder already exists, add your codes to it. +## How to Contribute +1. Fork this repository +2. Pick up an algortihm +3. Write your C++ code +4. Follow the File Placement guide below +5. Create a pull request +6. Star the repository to show your support -### Additional Notes +## File Placement Instructions +* Look for a folder for the topic you wish to contribute in (ex. Trees, Sorting, etc.) +* If your particular Data Structure or Algorithm folder exists, add the relevant files there +* If a folder does not exist, create a new one for your topic + +## Code Guidelines * Code should be properly commented so as to ensure it's readability. * If you've added code that should be tested, add tests as comments. * Make sure your code is properly formatted. + +

+
+ Example of good documentation +

+ \ No newline at end of file diff --git a/images/Good_Documentation.png b/images/Good_Documentation.png new file mode 100644 index 0000000000000000000000000000000000000000..b7da8edb3f3c582def6274d43ddd40531012d743 GIT binary patch literal 15772 zcmbVzWmsHI(F`3wO80ZT?&Tp0lY2@LbQ%f#0B*i^z*0Ae2X8z>J>2@1NRBYdIkxJa2#eLxkAnnIa$v zvdf5zsJiJNEMVJ{O(fGDmsa}5n!js1k)BNJrZ#%xi!wr?(;XU(%hsV!??+&4j?J$~ zU@qp^Kud;La8bL^-cXlW!iY-LnuL<)>}cO&V;_vUzghJDtEO83wUL$)O<7sAsYG~D zG@=aWVgzW_v-B4F;S%=1G-T0CQE>7FbR&PcCw#Uyb=0Kq*i*nX=<7HNzDuGYVqsD; z5yu~bP`FRfQBh@d3#H%FP{A+lb7B}S4i1h|tKqSnIQ)8I(z5~8C?8~n|A<3?689fZ z{agP&2$xXXnwqIaR&&zZ7G_V+ktVPQfm)|3u{o_|FRIgQO-RqlJ?@D2X2Kj&xic#5 zS`sg`r>k(V1D`Xm*Jo4qKqDK4&l_7?$T1c2WggqbcvBo>Kr;Wudj2^`Po5`L+)#bv z)bQO4i=H%%k~tJFr%eZ&Pu6Bhoh~+kDiKyx@?izo?PwRv%f9;J`;JRf5k9=&tpxN4 zPU#YpTU3JIiQPL9ELLx@X0+|#!_0URV|>gccjRK&se6bbQd9BFFl$N`m)G|s#Wu|y zZCCH@xZVCY?>AW}F6FZ=Wpy_vHs(WPT_UV774cwSifdjdPqYee;XEiXAH>i$m6X7eD5J1`PK0=aD$DVHIyEuc z)DT{=^TR z2^Su*tHgoG(6C!J?p3J}CS<5p->jk~U`mg0&wHI1R#I>UjquK0kz(JcYH_XaxCwmw z!(ujN@jZ1liNhKKxDJjV(86a^R%#IqT=8v8n78V<_196t;+d~|w`#t*MJ5-CbzxL_KI0P!XxR{! z(I+dUn&Hvy*s;M_Q@Q03xac|P!2U~RhXaJ&#IH#?Rs1VV~RWF^Amb;i$JmNS?(zM*`o0FotT*q;38kl3*!y4jBd%iFkubW3? zX87iOgXmE;XW}7tZa+kR?>k0B4L=Tyo;_?A+V%KIyqwvuWbjeXf^plI;~zhtq52y< zu69OZcT!l1rc!~>SutQ=!2YM6E(0oO{GQ!Hj zT4~HFL>F>kKS#Hm#0l4-$L8}8vd;qna|H)^Vt^Zk55er$i7VXGlJ(z~=pq+h8$+15`Cx8DPX`>n7a`y9Z0w+yo8+|~05Z<@-bT@QU4e!1USTZ-fop}|>ToywQO4b&|CmNh z)c=c6|Fxa}t-#ffn9-qq)zq`l1>2yZEe(@$)s}^3#8fhhHWDrxZWU@u*yr# zceP{tp`23PpuC!QJy2VTojMt>6=#ZAE5!uuJ_$wK%mvdDq>D}p( zXC&olvF}5NK1@4S2H%}u0q9Nvn~n&`R_#KHFvSQ<={qh zw`8>Nr0h&@DG(-I%g>CaY5)L+HGiPV0mgR@o8K%s2jrRpkyH35P zGBOjoL~!-bW0(OMOE7#)PEE=KAsA}c9>JtuqLkvUR?u-8zXq)8qdlF%(1w}T= z3L3+@#D1QHETqLaxvosj;03A?V8f?ej*BXu97pM!Gu=71xA@LX5l~HJ@=ms;BzuJz z6WgO|W1L$iMgPuj{bsyh8>GaRYof(!Qit%%T#aXfGmMe??z;fS!drPwzUU4a{_jMY zn&stKH0ftg+%cy}8 zj{>nxyzZ6XRZRv>fFs29%c}USOQ_h@-!w~=UJ~RD(Z2Pt(SSA74)+}Wv}{nC8mBGs zrkrzL$)fq@2tQSj515M9SqiRPrJ4t-X0d?evh?yNc$oZr93QgbIpRz0v8KdVpP|=euy;m%q=g~J!6qjhD zkBAIPHVS>nC?fUDmDwW=eo=Hak53BPlbIhiPDN!7g$e*7mFmd%B#yHpsjFG#s1LB~ z+2E0YHVLqcAGSgHx6v_rCHi&Fh`e^QjUq1xGp-`ScEG^ah*c@Utj8w z3`Xh<<-2WpGjqo~4C03^k*v8&_zWqZ=w*#a)Td8h z8-D-}t8VRksZYfPQ7eCj0Hx~vm$)Xv*i$i>aP#~v#*O%SUNd?2G`MRmw7D^}AlAfM^274IiBG2$8NrXSH=t$LAELTU^Zg6<>c)-yfp14b zEz8gPH-12=*N8s4Gy;qo%L}{11&K$OO+tt1DKMsYxmD%J8r*B&O zpiVS=I;0<^?70mEv{uRAa_-l^@UN_&tQQWZw`4#A`@WXPJRPyH<@Sm;9VTsbdy7Ky zqN_eFw~y7YqbNlCp$|D#;i25Q*UIR^#`B&LXy+|86Z^*u4fmzYYOsGC{N(6&B( zcqjl}&9vgZK1HBFMM+chLQnP6;A&w<4fVlWQ(FX+gU?#p#G0(-!sD4P?foNghn@Qv zu-T=n1x|?|wqaaP162<1JRzcyZ-q`i(;1&XH(TamVhjYP5&5{Uy`HnotFH>lI!Gl` zol;6DZ9QaNn!=ky8 z(3yaysYDCr7xV3f6Lvpeg%Grs@(U^3zAJYM^qkR=j0xmG%Y`;i zsbPOJn`RzK8>;1ZXe~31DV=!xCtbuGP!v|^+J^=$B2$r;{CuI`iFkm+xGKkG;yA#{ zj=oq3VSYFY_>?`IWkI=KLR_e%YQnl(Iv$|D>tH6YbL`-#Map^sJ*}hC+53wanV- zo21nZmRwqukjyOg0lgZ6anHUxE7BxweDxPLdEX=|XCHC1lGQh+M;?SxK21!Py^=&f zLSC7(^S)HvVDpeikkykE5kVb|Z1wQk1#m}SR(B5- zb$ED6Yq<59Bv-4I;!iRHd?#z!E&J$3=lqMdh;*aMyffLGb(T`fq~bR3=qRER-{x!* zZg|WpF6EBKWGBv2-@92tdMdvkP0%EobJ*;yDa!R(vK(v+8b~|p`LR?MFMUqV#n=pM zUf5hjV-~IH<9Gakf@`I>E~GAK!Hl&Yz+}~T&UO;Xu5z=2sOpv?<9qN-huiBxW^#?C z%OP%^i)!+|Y&{>HzKZ-sn|8GhXvm8ULR4`dLf)?2=#8u9mZCMuyLca5SK59#HZ9H0 zi0n@2!~AVSqZhuUn+JNJ7q5f8OYF?Qt$pCQ(3s|vo7^+&Ut=cx>GC=?++_62Z%9Lq z_rYfOTyfX0uD9a*!*sP% z19I$uY5dh)g*FQI1X4Gwl4Io~I*w1?@50ln7OyM3Tyrw{``f=eCJSTFu2{+qcEp7^cVdf>f zw+70u4PMokm1aUyrwgBGdFff&K1R*Lys`eJNQdoZm|fS2#_;Mza(6UD7g(BO`o23U zBGYrE%X?bWEga?Xy4|CTaOX6;$tRqqG4jT7^K!qB5%V*df6l1rbzVIdjTL6I$u>3$ z>!$n464O|L7(nt>G8NlYt~*-4h@Z_}w#3qD&7k;m1%?(q@;ZtH-)-NVE5mOE;vjepjw9!!JM+eYh zWvBhP!0^mZ0gwq(Q6WxE9Pdhw0HvM#zdgTb3O`v3Vi)ouYc-`?`8gK(fOCQFPCZso zbj`eP<$hGhq@<_ztW;JkM~|1)?>C^H?NBRF8H7iHEfBayvD+u*e8D61eTn}_GTQ|A zu2d*&ZPo*GCHw;I#^q;2d{|N(vY zMJNHA-4YJpppTl(o_b;zexbqXFR|;;!ok0wP;;k7I_`DaZ3x>{+JU)xz37IVE<0?5 zf%M9|U*8aps~JR^5rsCo>PPnOsgj_B>+;e422`8 zH=kbRx=HD<{xop747&P(9kmT)jYRC@v%u}W&L$x~mteD4Sm9T&j6Ev)FG-K5h-O0NBO`a#Hn zP1Y}0a)qF^zLxb3T=(gf(S39j>EtdW*X8cSNzOkBvHjv@^kWz|j@adW?IcL=wu~pD z{(3nUF@GV-66dwKo>Dn_h5y_ew6jduw66B>#$~7GP~DijWB;30c#xR!2>-d|uyhGf zQ&I6n#bEpN6(~~q95Ny6N%nYrw-PX~kJLuz$Ww1ZJty-oW>7&a+f8np$l0>ZRyjx?~pG0Xwg08nJ05QK5o+fBeSs7xqm!95Lb^>vhauJ@k_J)pmde z3>MY%o-O?~0}!R)Wvor49#UctLU%Kw+S{4ej0q4KfMH^4fI*R`OhpuU!^FvxWmi30 zxl^?Cx#B2(oq}1Dl@tpjG621x{ww-EvO7`U4dotr5cd_H@Ody6V>ihPM}PVq}~i6xK)Sm)5%FcM=Zb~ z!fJ-6mpvrCJewZtoixWwrJg_)#}}=u(nP3qs%vj&jtjk;xEBI3%KDSVkqav!CqWs| zJUfoj$spy-Xca2)mlUa=C6hIQ-tHhP6oOL9RO`H4fFp*j4%7ZqZnqy1pvJA);b|+c zQp+Z@HP#^x)tbe$ElZ1(>%e6U>&uO+sC4}+JxYk$_<`)V=7Wnm*S6D>{h+b0w^rj5 zJ@4X8JeIw6w>bcAVGCC${o_VgLf*(P{u1_vuU>iPP_;%sa1Z4&p@-&SH>Jnk9K2I$7Y zu}r3!oX`+GfLs!!DmnzW=YVi_!0i>K19% z+tJ5OOS?mPZ%YFeJkVmV0DxJIipmwG8ju{jWGFvrT=W$rP8k)}c|`09KAuS6KK3b0 z8*$-z}$k5GYv{SCBs8xVOa(8S2EJ(g|Lc$KSz2vsK$Opc)W z4v$Eob`cy|JE+d_0M|_`S|hCqda@rD{J*(-V%5srl8jAX<{^MSX- z>RU?*Tli5Oj_Ez!U&GsC#D7Bim+4qxNQ>8fL;#i2P5xm-{+*)mMl2t#r9TcrOlQnL zfa-rb2<7O0OY&}?_H4=Ocamz=xpybZc+z)j@wHfne=HBX|NE}o?<EpC3lsU;HTEbh#*$A%kGcaF!{>55V%p@!^Q7RN1a#(!1?8B94=OXlA zQzUpNH;?-gb`L|BwLNTGn;ZX@wGfuNq#J_AsvDFuVE`F)a=#|WhYu`+jiGs^80qlh zqv{}Z^K#GE?ATLz`0tD z@AWMQoQ%iGyx-gg8idWQzuQtft6pb zClBji>cSIEH{KVbM+z^p#7}`Ucch+kDNIj>@zuj=2!Fn;?-{h zmO)4^I6*U3p$@w(S8g?mUU-c03)_7B(nPFpNJ%mn7WhrVTJiY^x{Q~x}1%NiaPhj<1w1=U1A!PUo8*~#Wo2Y8d z?^2o!l!dSMoN>421i>e)jP@J7%&MWu5A=!zZPl!mG+;N@a$LRQZ*E=wxiOy)e zU+b146u!a>DDm{d$N&S4F=knr+Cp0OWL%(+CcVlndwPg9*>!*G(Ne$x3xHeZnf2Dx z2-mLU*3gj>-Urj;`ks*XsN89b1550jAr>k3Ub|rUE=$!bkLhzZJ*eXo4v1g+x+NBB z?&_0GvPi_|02#9q9d%h@V(m|Zrf9GoPb!pgdMrG9T;Ppue+dy)HqFz&3@){u|C00G zWP!q?F&7Up>iJ9A{x{m;-yMcJpk$D7+4e|0TQ36jihZ(@XibPK(X66%E?vy-F9DQs z#W6NyH}mPsJ47+G3nNMSUhcmvM{E&11hcQ#J&rnmtGWEA{n*fRe}h|8)j9!ULH2ao zKWxfIPL;obxid?P@*lI=i@fs$tesy)4$3` z0~d_D?l%c>{rv%yO$<|SS?K@g9jtIp3Xk|`#@}B`Yxhsf*VIj@c7F!#{_X#pj4?b; z!hw_7NALB1y~HwG`pQKLXwR4AY=!SseB51EAK@~mdUi%flbt$~FGSY~=fGLyi}Q*m z(QaWzZbZjw5GD=v<@KJW!t%2sYvh-|e-M)kMOIqH{HnZ1WxicDBYUt{r@-!M=(PfP zL4xchladl1A!5g^C&!*KL$23%&GK6*=PwzH*$SL-6O$6z=9I`MwIW4Dvm+s+ zGGjgf8D^WadJJE8$}!}kIrF>c*nz4kdvgMaK>1>6u@4joyGb2gN#F)+PQLYb@^1Ar zJ)DnghKoVXlLr}4P->y1_DWo_>cT2E#fS7LfgEVAQ=;mLUOZ|z;kP@<@c|o#C&WDw zR92_0#OPOT=K34WDdsazF37yBsQE*wD5agEwjBG+8LST{IcTEVGKakyt0F`~Q z^mLqc^l~n&T$NPrYc4>MFX_C3-9nAUBNCA-S=*!`@&YSZk@n?8zmn6A8$3D?PqQNu z0U}iu&>**N+|i+~5cI`OPoNALro91FJqs=V;1!fWNKcu%+nF#FK(N{6r`7wXcP#l& zz^6E;k9icPO+)%uW^A#hud9fs)w$9-@V{uOwdmnxzAY=1$9~Z>`+5&K&BtDtqG@8<_hVK6@z&r z7R+ys2e9#og&jW>xw7wvpu|+{iu_=1Qk!EAq>M_8e|=VQV_1Ad76!~>GMx#qVSY>x zsiUlpF=*XnBbe)f+)`nl4iuhnl+4(d}#)J=6t+N7)fzbR@?Z>r>W&76@) zKdo>+Nh=@YenoAT)Gp`ao!e>fO;u|6Lks_oLY-7JNfcU5B9?uw(ri-xV|bZy#uR{R zS9#^8YgeRdeh%He5!Wn5o^fd=ZR9PSY8P^Pv8MF0UhOaGrSmeAq>Z#utLM7!{`lj% zkeS(p?*)`<$!ysjF|KYys22BlJEFbn9w^L3@Zq*iPU-L-Ux)*m?0L~{+2YN$yGwOB zLHcVydL?dIh)Ar?iFSC+kJ4(^JZcSFLL)OrU*7eD@qQJaOP|ZfHaNDS_hVk@+O_o{ z25YxU(zaNm(A~J!O)IT6sd?b6w%eQct$;W2qHsdZ93bmu9m!5F}StO6>j4mc0i1+ZdYJ?SrTzNQ+MCcKg|-)mVk3 zXXa`keQ9;c*9LF2-8OwlGRa`qE6vIR(TJV3SESHZf#eFY=A!QIqsT5oF0OB0D@sMz zGcV2(`rooBRNODzxDx=5h`#$UZQ^*Wn0sdx86xM(8Mso+IHfM($yS2Ir+H7^sT%-KXI6#FHTsV3 zqk}zDD>`bd{9W{+VU6+Ec0MWv;rxzF2;)&Udwdd!gnIBn@o#xoIVpdf^6&k!aRX({ zUe=JDg+?y7^1jmuqqJga~b$PDRM9mhd-tw6pf1^bt7oe0uCiCXATPws)@IODl#F zvY(T}eu(ip>%$p*c-p{f_?6eEk3}<&4F2NW{RAxD$hlNZ*c`0_+3ImX1KA)31GQF!Qt<6D!qK&~_%@9C{Gt zywZ>@Xi;w#&mC#A1Znk@J?`BtUHkUi^`}^>E%!~|@)DgXmyi9JjjS(T9RzmU2`_|zA zAQnY@4Twl^-{ysNj=|lEB1!ur4%jSA@THbbh9GgrAl6#+&;!PO)XNB2_1qUbO)p~> zr&6Z<8e}6gpm8QVu5U$W4PID&o?Gu&0yjU+EHDe6j#?xT0VKSM&w)2e5^KRo7GVL3Be;9N)nNIOb~Peya?;Uy2%WfH+whJDM`6 z{F^aBJ5u6)>Y)2WF5<5Xx{AcoBkIrh#bkUW!~;sFf99;ps1( zQQv}#yU5nEjs7{pn$&gfI>`~?sTZ2AdrRN;_e>|{a`ZUE(tDnbOUddC90?qY9MYW zPhMeIOYKq>+g-ieyYYnQbEt>9{3gjrzMOPohQUH;9X&X(NtabDzil>{2}1-2zl==s zpYw#pvYwp2dBvdadE9R96S()oRiv}bJS|Vaz(Tl@C3mFyhVKBUh|E^Wm(}H7JQcL* z;k}5lR=d9WR)AbPip!4MD!)QJs>c5(DAW$wiDJ(4Ol(#vXb-4Nt?N8!qZ9OD$#3ea3-O&mo_a24vAo(jY$=A>Glh+LvrD?39ieyLy&tQ~QWQkg&Q zxdwNfWPJMa64Hk3S-drQ&(39n7(&s<7>|~jPGsGw#d2{ZT?$3}aNojB5Jo|97c$-I ztEF0_vzIYr#aB&%w8m~OBVX2=P^pCS#%UGO?v@eP0|}VLj<8%DWqLd@~kI8a=`PM0QM6xMj#I|(8S9X$#Saay#fnePzSQXuUs`A z0?isCeGQ$i0)r0kBBo}!+m*N_!DXD=W|lI&NpF@@2<1KZFUU1Kt&r66k_@@S!PH%q zWpl4JMQG{B3cWw-Zh`6wN2EbW0n@liE|F>~ciitS6oqHR8`m4yohGNAIqvW1p0Yi` z2$edPoIv9P@gW6+ zq<3IJXz%hc3}2uBQnZBkq^FTn!+BUvRcuN}m{7Dpyn|=Z_?h6*Muk<}FZF^X8U_@w zH;-8}+p|H*v1DD5TB0OvGM6s}Pzpwb^?lwori>uV{2QDLhUVnT>x4O7zeM>fJaEhp3D*=NiYn4X@ z$h%1{yw`iRgUXoWIil!{tLIBvvt=ZLz%h~dEeN52 zi;Y>V6Vp?LrLgBXJh|GtpP3534scpw*&@TKiw($mESFnspJ5ii<}Swslb;ZgdIHc; zu*tV&h&Aqy?;IISflOkJZI=E`?AD>sAtbG}$~HP-(x!_#0~6wSfW~*|a$V1E{Va=R zjzCJ(oz{IArltbmT97 zja^_F&6TMDKXH-Q5yqi2KU9x&o5%rUI{aiN18p7J$j?xy3{gHZZDWyb4d-h!oa z5`NEsS__Yeh5*sBfq+q(v(+?}HJlF$p%e@Kl5tP#CcK|!P_4d=)puxwnUKcAyu#`B-$Z5_KjC!TPU39CiHj)?W>$DS;Bo2-vOTV z?OkRLg3A`G!_Oi|2l5Nx>M9uqQ(^kVvUFz+hl5Y;h~;_r>!73st4~7Tg&A9>J#${S zbkr0e(xkMOVStJXiT9+AVGfq9VN2#%lVa|In`!10&kI^;?_GLgs7+Fc!==)m1}D`N zsTBU?A+e;>GNzSlM7B(#z)qENaaW;~qx9c1^M)lAJ-rf5#SHO2z#>bfYB^BKu6*hR zVjjWj=hRSQ>&8_nmzIS(R#pp#hDyBFDZFe<4?MQQCI8LwQ?W1RwoK}Tp(0kY5J6u9 zvEk|$1{rwvdrw>2_uS+B7w%gW+W`iP2t8}mXnZylM;P&E9^RoYQf^Dt*=QL9&Ve{GOf~KoIDhuGCi<1e@ zgCmuq@S+P)8P67V-ct(dO=EGX`)7Woul6_SJBtPwEe{uMO zVWK&Ew_Uu1ABEmTX66oq_FpzSi~$@96Mxq_$o+h6^WE7)-r2=TU5h}LnaH{FS#0cF zk#9x_R7z2gV(2!?m+rtXL~|}%P!a$dj5dO6flwr<{WIIP^@~&P zMqSYou`a8PblrVExnU=kDpCdzbU~~ahl#e?<5&DbTTe@Cf~rbegluM!!m$ZyuNc*d z;lkZ?@sqc7nK*yRaE$t$BmhV9CsJ-LA}`lOkc!jlEa7SUCl->asLCfaLwC#v?fCu% zc<%2(8iqI01$4GTF;SKW7ELBZwi+saDPltnXZBU|!D!+3##<2C(PonAZ9)MP(qiWVMdfi3w)>QET2(ubNNX z9IK;osm6p{*(cF%AkM2nd#qhvOGYqkE*fsM-N~>Yx^d^dRxf_WuU1+`#&L_!8aF|2 z3Or_oqHC&Gw4YTm5)pl-85o@+U-FZWu223RaT+PU`v5>TCdcsj3R{(Ou65cItTm92 z*xP9*PI1oU%ocJ>ZC~%_EwWPVv%MAasmxb?_>DQU%#!W%6$q^&B5Idf4Lf>*bH6&TFW+`J z>wK_j`n-U2(*=1}g~0*uyZvQYB&sTJxIXh&<@k|PZ38QW(m&6n-siOmtNxS`yR|=$BHnvY$H=Ee}>XXdY zD4YZ#EN=VNb|%FR%(M%0{vTbOT?V8SEF*rkxxyU`5Fsb)Lex=~PN_h^B6-&3bkCZ@9cCL)vA z%}z5(we{veziM|;56>5-$b&<`J>F=$3Q*8ix?= zeO=!tou@!7bxuM`@B=q>uZjE&sCv~Hui^whzHt~M=Byo<#ioZd1aIJwb5)+j!i(On z*i5kanTAU~t_K_feDyCR6KCM+;YNkB4b$x6$ zLl>X@s=9a<;kKLnJe8+7Cn2Pzw(H4*wB7RE1?SN#|0R82+=j$Iyl<>O6)N~1&y!ss zTe7Xz5Om8f$d%ruqd29Hk#serpGEr!i{Naey?fcXqejj52(DJ_A{$m}4e?gT!Qxe2nDpeLI^HZA_|3Ago}1-DN$_P|?PvRTF; zv=e{h*Dq*G8qw@5#{AFTbuM)v@)l=`dX+$ueZh5Tm!E-UFNKFk^>L;5CYdNY(l6w1 zf@>OKbMkIonv<%2%nvoUy%RamiW~x!y9iAcfk=Pw^)Dfx-3A_>=c;N;g;7i(;bsbC zy93DD95MdmaW0<_V%Uwsegw(%AlU-^eBDb1L$y~84sbKLvTJ_WCATIwGWr5jv4Q{h zHgLzb2=8q2)$i8CBvpIom)66U9hbIp()h)HQQ z!An%PYkQ^8#{xgbNYzV$=`+U0S7YFf`%&ndGpnGlc_&0Jj%7mDz<+|=wp~rKIw(A$ zWsYt_YNa)$0a?Utb{=5t+K1^=WiEK=bJ{@6;E-YAf|_Z?{iyvyCdWxMXZ~=uuSwQl z$eQa(QJqBx)1F(@TB_M_p{S)6fpL!%Met*yLk0}848SlY2+jx`aC@T;kCrPFSesE& zIRP=840U;04`rw1aJEtP;kS+0L#R@%!`i@QzH>b`fE(ZFyh(31LB#I(F%O{U4`CH+ zK!pZ2ORB#2=I5?S7Y~nn*E7_5?-Owkrre=;qM!?X_44+b9s_+Q2w!!#bA@IQ>e z%s<;-9?qR;1-%r!W^6tI>1lS~;B8uAW5Zx(y259~e1~oylO!Ki6JI7a#sFtt2!?Lk zeoL&O(m#7R@3)Jmuu2N_A*y+}E+jT^XStZKlN``<1M>4kX2i&H{jI3gv8;g#B5HCc zx<4IZ;OZ>690B8=-Kfdf5d|tB$;FqB|22J%YJUpyKPW}~p*mS`;oHz{LM6j`bvF+>zBDLmxhlPX*6<)9&rgxkjGYSX4%;&w!X8?} zaDn~VC8D#)VWBOqLx5f1OofyOMqD@+9nBxN90I4$cjEMT;^RvX9xZK#wH(XUPnu?` zV?8P)gPCI%x_-CgtiNaI@MYG0d>;0NVC_UqFSI=kVH&QM*^R)97V2r@$+~tD*dYaB z$&LR8w5wtrcamLsWeP?i{y?i$XK@ho{(|k$LC6>?yq1z z*PadR$CFG~r!;gYy`YQy{70#aM{jsnqy3q9ahA}({IqyT_uO9{$uKSdC(Rb+_yO^< YWuW(mMC32{iE0EHiI3tXqK1C|14TE^P5=M^ literal 0 HcmV?d00001 From 3962eb6519d0dc6e269565834b47215fc57e66a4 Mon Sep 17 00:00:00 2001 From: Brady McNeely Date: Sun, 11 Sep 2022 23:21:28 -0400 Subject: [PATCH 2/3] updated readme --- README.md | 2 +- README.md.backup | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 README.md.backup diff --git a/README.md b/README.md index bd9263d1..42e63d48 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,6 @@ Anyone can contribute to this repository.


- Example of good documentation + Example of good documentation

\ No newline at end of file diff --git a/README.md.backup b/README.md.backup new file mode 100644 index 00000000..42e63d48 --- /dev/null +++ b/README.md.backup @@ -0,0 +1,34 @@ +# Data-Structures-and-Algorithms-in-cpp +This repository is in development phase and will soon provide you with C++ code of various data structures and algorithms. + +## What is this for? +This project is designed to be a reference for anyone needing to implement a particular data structure or algorithm into their C++ program. + +# Contribution Guide + +## Who can contribute? +Anyone can contribute to this repository. + +## How to Contribute +1. Fork this repository +2. Pick up an algortihm +3. Write your C++ code +4. Follow the File Placement guide below +5. Create a pull request +6. Star the repository to show your support + +## File Placement Instructions +* Look for a folder for the topic you wish to contribute in (ex. Trees, Sorting, etc.) +* If your particular Data Structure or Algorithm folder exists, add the relevant files there +* If a folder does not exist, create a new one for your topic + +## Code Guidelines +* Code should be properly commented so as to ensure it's readability. +* If you've added code that should be tested, add tests as comments. +* Make sure your code is properly formatted. + +

+
+ Example of good documentation +

+ \ No newline at end of file From dc5341a274e56582b06deeaa9b70e1809b7f7374 Mon Sep 17 00:00:00 2001 From: Brady McNeely <68303776+bradym09@users.noreply.github.com> Date: Sun, 11 Sep 2022 23:44:29 -0400 Subject: [PATCH 3/3] Update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 42e63d48..7a66fd6c 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ # Data-Structures-and-Algorithms-in-cpp This repository is in development phase and will soon provide you with C++ code of various data structures and algorithms. +# User Guide + ## What is this for? This project is designed to be a reference for anyone needing to implement a particular data structure or algorithm into their C++ program. +## How to Use +* Find the folder with the name of your Data Structure or Algorithm +* Browse C++ implementations of your chosen topic + * Your topic isn't there? + * Consider contributing to help fill the gaps + # Contribution Guide ## Who can contribute? @@ -13,7 +21,7 @@ Anyone can contribute to this repository. 1. Fork this repository 2. Pick up an algortihm 3. Write your C++ code -4. Follow the File Placement guide below +4. Follow the File Placement guide below 5. Create a pull request 6. Star the repository to show your support @@ -31,4 +39,4 @@ Anyone can contribute to this repository.
Example of good documentation

- \ No newline at end of file +