Merge branch 'master' into stable for 1.3

Author: c-cube

AUTHORS.adoc

@@ -20,4 +20,5 @@
 - David Sheets (@dsheets)
 - Glenn Slotte (glennsl)
 - @LemonBoy
-- Leonid Rozenberg (@rleonid)
+- Leonid Rozenberg (@rleonid)
+- Bikal Gurung (@bikalgurung)

CHANGELOG.adoc

@@ -1,5 +1,23 @@
 = Changelog
 
+== 1.3
+
+- deprecate `CCBool.negate`
+- add `CCString.compare_natural` (closes #146)
+- add callbacks in `CCCache.with_cache{,_rec}` (closes #140)
+- tail-rec `CCList.split` (by @bikalgurung, see #138)
+- change `CCRingBuffer.peek_{front,back}` to return options (closes #127)
+- add `CCRingBuffer.is_full`
+- add `CCArray.find_map{,_i}`, deprecated older names (closes #129)
+- add `CCList.{keep,all}_{some,ok}` (closes #124)
+- large refactor of `CCSimple_queue` (close #125)
+- add `CCSimple_queue` to containers.data
+- small change for consistency in `CCIntMap`
+
+- bugfix in `CCRingBuffer.skip`, and corresponding tests
+- cleanup and refactor of `CCRingBuffer` (see #126). Add strong tests.
+- add rich testsuite to `CCIntMap`, based on @jmid's work
+
 == 1.2
 
 - make many modules extensions of stdlib (close #109)

README.adoc

@@ -4,6 +4,8 @@
 
 A modular, clean and powerful extension of the OCaml standard library.
 
+https://c-cube.github.io/ocaml-containers/last/[(Jump to the current API documentation)].
+
 Containers is an extension of OCaml's standard library (under BSD license)
 focused on data structures, combinators and iterators, without dependencies on
 unix, str or num. Every module is independent and is prefixed with 'CC' in the
@@ -91,7 +93,7 @@ and <<tutorial,the tutorial below>> for a gentle introduction.
 
 == Documentation
 
-In general, see http://c-cube.github.io/ocaml-containers/ or
+In general, see http://c-cube.github.io/ocaml-containers/last/ or
 http://cedeela.fr/~simon/software/containers for the **API documentation**.
 
 Some examples can be found link:doc/containers.adoc[there].
@@ -135,18 +137,54 @@ To build the small benchmarking suite (requires https://github.com/chris00/ocaml
 
 == Contributing
 
-PRs on github are welcome (patches by email too, if you prefer so).
+PRs on github are very welcome (patches by email too, if you prefer so).
+
+[[first-time-contribute]]
+=== First-Time Contributors
+
+Assuming your are in a clone of the repository:
+
+. Some dependencies are required, you'll need
+  `opam install benchmark qcheck qtest sequence`. 
+. run `make devel` to enable everything (including tests).
+. make your changes, commit, push, and open a PR.
+. use `make test` without moderation! It must pass before a PR
+  is merged.  There are around 900 tests right now, and new
+  features should come with their own tests.
 
-A few guidelines:
+If you feel like writing new tests, that is totally worth a PR
+(and my gratefulness).
+
+=== General Guidelines
+
+A few guidelines to follow the philosophy of containers:
 
 - no dependencies between basic modules (even just for signatures);
 - add `@since` tags for new functions;
-- add tests if possible (using `qtest`).
+- add tests if possible (using https://github.com/vincent-hugot/iTeML/[qtest]). There are numerous inline tests already,
+to see what it looks like search for comments starting with `(*$`
+in source files.
 
-It is helpful to run `make devel` to enable everything. Some dependencies
-are required, you'll need `opam install benchmark qcheck qtest sequence`. 
+=== For Total Beginners
 
-Powered by image:http://oasis.forge.ocamlcore.org/oasis-badge.png[alt="OASIS", style="border: none;", link="http://oasis.forge.ocamlcore.org/"]
+Thanks for wanting to contribute!
+To contribute a change, here are the steps (roughly):
+
+. click "fork" on https://github.com/c-cube/ocaml-containers on the top right of the page. This will create a copy of the repository on your own github account.
+. click the big green "clone or download" button, with "SSH". Copy the URL (which should look like `[email protected]:<your username>/ocaml-containers.git`) into a terminal to enter the command:
++
+[source,sh]
+----
+$ git clone [email protected]:<your username>/ocaml-containers.git
+----
++
+. then, `cd` into the newly created directory.
+. make the changes you want. See <<first-time-contribute>> for
+  more details about what to do in particular.
+. use `git add` and `git commit` to commit these changes.
+. `git push origin master` to push the new change(s) onto your
+  copy of the repository
+. on github, open a "pull request" (PR). Et voilà !
 
 [[tutorial]]
 == Tutorial
@@ -441,3 +479,6 @@ printer:: `'a printer = Format.formatter -> 'a -> unit` is a pretty-printer
 === Extended Documentation
 
 See link:doc/containers.adoc[the extended documentation] for more examples.
+
+Powered by image:http://oasis.forge.ocamlcore.org/oasis-badge.png[alt="OASIS", style="border: none;", link="http://oasis.forge.ocamlcore.org/"]
+

_oasis

@@ -1,6 +1,6 @@
 OASISFormat: 0.4
 Name:        containers
-Version:     1.2
+Version:     1.3
 Homepage:    https://github.com/c-cube/ocaml-containers
 Authors:     Simon Cruanes
 License:     BSD-2-clause
@@ -67,7 +67,7 @@ Library "containers_data"
                     CCPersistentHashtbl, CCDeque, CCFQueue, CCBV, CCMixtbl,
                     CCMixmap, CCRingBuffer, CCIntMap, CCPersistentArray,
                     CCMixset, CCGraph, CCHashSet, CCBitField,
-                    CCHashTrie, CCWBTree, CCRAL,
+                    CCHashTrie, CCWBTree, CCRAL, CCSimple_queue,
                     CCImmutArray, CCHet, CCZipper
   BuildDepends:     bytes
   # BuildDepends:     bytes, bisect_ppx

benchs/run_benchs.ml

@@ -20,16 +20,24 @@ module L = struct
 
   let f_ x = x+1
 
+  let rec map_naive f l = match l with
+    | [] -> []
+    | x :: tail ->
+      let y = f x in
+      y :: map_naive f tail
+
   let bench_map ?(time=2) n =
     let l = CCList.(1 -- n) in
     let ral = CCRAL.of_list l in
     let map_naive () = ignore (try  List.map f_ l with Stack_overflow -> [])
+    and map_naive2 () = ignore (try  map_naive f_ l with Stack_overflow -> [])
     and map_tailrec () = ignore (List.rev (List.rev_map f_ l))
     and ccmap () = ignore (CCList.map f_ l)
     and ralmap () = ignore (CCRAL.map ~f:f_ ral)
     in
     B.throughputN time ~repeat
       [ "List.map", map_naive, ()
+      ; "List.map(inline)", map_naive2, ()
       ; "List.rev_map o rev", map_tailrec, ()
       ; "CCList.map", ccmap, ()
       ; "CCRAL.map", ralmap, ()

containers.odocl

@@ -1,5 +1,5 @@
 # OASIS_START
-# DO NOT EDIT (digest: 97e963a89adef885748c84195b76d95c)
+# DO NOT EDIT (digest: fe2373b07664be05f7322781403afad6)
 src/core/CCVector
 src/core/CCHeap
 src/core/CCList
@@ -53,6 +53,7 @@ src/data/CCBitField
 src/data/CCHashTrie
 src/data/CCWBTree
 src/data/CCRAL
+src/data/CCSimple_queue
 src/data/CCImmutArray
 src/data/CCHet
 src/data/CCZipper

doc/intro.txt

@@ -93,6 +93,7 @@ CCPersistentArray
 CCPersistentHashtbl
 CCRAL
 CCRingBuffer
+CCSimple_queue
 CCTrie
 CCWBTree
 }

myocamlbuild.ml

@@ -1,5 +1,5 @@
 (* OASIS_START *)
-(* DO NOT EDIT (digest: d0913c9409d93aeda14a31d6f9ebb3b2) *)
+(* DO NOT EDIT (digest: 9ebeddeee0d56b1f8c98544fabcbbd9b) *)
 module OASISGettext = struct
 (* # 22 "src/oasis/OASISGettext.ml" *)
 
@@ -105,10 +105,7 @@ module OASISString = struct
         ok := false;
       incr str_idx
     done;
-    if !what_idx = String.length what then
-      true
-    else
-      false
+    !what_idx = String.length what
 
 
   let strip_starts_with ~what str =
@@ -131,10 +128,7 @@ module OASISString = struct
         ok := false;
       decr str_idx
     done;
-    if !what_idx = -1 then
-      true
-    else
-      false
+    !what_idx = -1
 
 
   let strip_ends_with ~what str =
@@ -440,7 +434,7 @@ module OASISExpr = struct
 end
 
 
-# 443 "myocamlbuild.ml"
+# 437 "myocamlbuild.ml"
 module BaseEnvLight = struct
 (* # 22 "src/base/BaseEnvLight.ml" *)
 
@@ -520,7 +514,7 @@ module BaseEnvLight = struct
 end
 
 
-# 523 "myocamlbuild.ml"
+# 517 "myocamlbuild.ml"
 module MyOCamlbuildFindlib = struct
 (* # 22 "src/plugins/ocamlbuild/MyOCamlbuildFindlib.ml" *)
 
@@ -881,7 +875,7 @@ module MyOCamlbuildBase = struct
 end
 
 
-# 884 "myocamlbuild.ml"
+# 878 "myocamlbuild.ml"
 open Ocamlbuild_plugin;;
 let package_default =
   {
@@ -921,7 +915,7 @@ let conf = {MyOCamlbuildFindlib.no_automatic_syntax = false}
 
 let dispatch_default = MyOCamlbuildBase.dispatch_default conf package_default;;
 
-# 925 "myocamlbuild.ml"
+# 919 "myocamlbuild.ml"
 (* OASIS_STOP *)
 let doc_intro = "doc/intro.txt" ;;
 

opam

@@ -43,12 +43,8 @@ available: [ocaml-version >= "4.01.0"]
 dev-repo: "https://github.com/c-cube/ocaml-containers.git"
 bug-reports: "https://github.com/c-cube/ocaml-containers/issues/"
 post-messages: [
-"Major release, with breaking changes. The APIs are more focused,
-more consistent, and some sub-libraries were removed or merged into the core
-ones.
+"Small release with many bugfixes and a few new functions.
 
-A summary of the changes can be found at
-https://github.com/c-cube/ocaml-containers/issues/84
-and in the changelog
-https://github.com/c-cube/ocaml-containers/blob/1.0/CHANGELOG.adoc"
+A summary hub.com/c-cube/ocaml-containers/issues/84
+changelog: https://github.com/c-cube/ocaml-containers/blob/1.3/CHANGELOG.adoc"
 ]