package base

Release v0.17.0

Added functionality:

• Add String.to_sequence
• Derive equal on Set.Merge_with_duplicates_element.t
• Add Queue.drain
• Add Or_error.of_option
• Extend Hashtbl_intf.Hashtbl with capacity, intended for testing resizing behavior
• Add Nothing.must_be_* functions discarding (parts of) inputs with Nothing.t as a type parameter
• Add Float.log2
• Add Random.bits64, re-exported from Stdlib.Random
• Add String.edit_distance to compute Levenshtein distance between strings
• Add Comparator.to_module and Comparator.of_module, converting between Comparator.t and Comparator.Module.t
• Add Map.sum, unzip, of_list_with_key_fold, and of_list_with_key_reduce
• Add Applicative.Ident, similar to Monad.Ident
• Extend Uniform_array with more operations akin to Array
• Added List.singleton
• Add Map.merge_disjoint_exn for merging two disjoint maps of the same key/value types Raises an exception if there are conflicting keys
• Added Sequence.Expert.View to consume sequences more flexibly and efficiently
• Add a Binary submodule to Int, Int32, etc, which provide to_string and sexp_of_t with syntax matching the ocaml binary int literal syntax
• Add List.stable_dedup and deprecate Set.stable_dedup_list
• Add Queue.enqueue_front and Queue.dequeue_back
• Add Type_equal.Id.Create* functors for polymorphic types

Added unicode support:

• Added Utf* submodules to Bytes, Uchar, and String
• Types for Uchar and String encoding UTF-8, UTF-16LE, UTF-16BE, UTF-32LE, UTF32-BE
• Added conversions, read/write functions, etc

Changed behavior:

• Info has improved parsing of DOS newlines and trailing newlines in backtraces

Removed definitions that were previously deprecated:

• Type_equal.equal type alias now that destructive update is available
• Map.comparator and Set.comparator type aliases
• Base.Popcount, as it is exported via the various Int* modules
• Option functions from Container that are not useful
• Result.ok_fst, an alias for to_either
• Sequence.merge, an alias for merge_deduped_and_sorted
• Info.to_string_hum_deprecated
• ?trunc_after flag to Info.of_list, no longer used

Deprecated:

• Type_equal.Injective, now that injectivity annotations exist

Removed without deprecating:

• Type_equal.Id.Uid.to_string, of_string, and t_of_sexp. These were not compatible with the representation changes needed for the new Id.Create* functors

Interface changes:

• Container.Generic now supports two "extra" (non-element) type parameters
• Abstracted some of Map into Dictionary_immutable interfaces
• Abstracted some of Hashtbl into Dictionary_mutable interfaces
• Export Set.Poly.set type rather than using destructive update

Bug fixes:

• Indexing was wrong in Sequence.findi, now fixed and with a regression test

Performance improvements:

• Split up and refactored tests in Base to reduce build times
• Stop using exceptions for control, primarily to speed up js_of_ocaml versions. Affects Sequence.compare, String.index, String.rindex, String.index_from, String.rindex_from, Map.change, and Map.remove
• Unboxed Int64.pow
• Branchless implementation of Float.clamp_unchecked, Int.clamp_unchecked
• Branchless loop body in Array.count and Array.counti
• Remove allocation in List.Assoc.find_exn
• Reduce allocation of With_return under some compiler configurations
• Restore Array.equal to zero allocation
• Avoid boxing in Int64.to_int_exn, Int64.hash_fold_t, Float.hash_fold_t
• Inlining annotation on Float.sign_exn to avoid boxing
• Add [@cold] annotation to Error.raise
• Tighten up conditional logic in Hashtbl.set and Hashtbl.remove
• Reducing redundant computation in various Map functions
• Rewrite Array.min_elt and Array.max_elt to reduce branching and allocation
• Improve ppx_hash derived code for enumeration-like variants.
• Moved queue mutation check to a function marked [@cold].
• Rewrite List.dedup_and_sort without a final remove-duplicates pass.
• Fix Info to avoid blowing up the stack on force of the internal lazy.
• Make List.take, List.drop, and List.split return the original list when possible. (issue 153, thanks @mroch)
• Adapted List functions to take advantage of [@tail_mod_cons] where beneficial.
• Use [@tail_mod_cons] in Sequence.to_list

Refactoring:

• Update whitespace styling, primarily by no longer using ocp-indent on code
• Use Stdlib.Sys.Immediate64 in Int63 instead of hand-written copy
• Properly use loop variable in List.chunks_of helper
• Rename internal variable in Hashtbl.remove for clarity
• Lift some of Int_conversions to Int_string_conversions to share elsewhere
• Remove unused [@tailcall] attribute in List.group
• Use inlined records in Map and Set internal variant representations
• Reimplement Map.Build_increasing to something simpler
• Remove unnecessary helper in Map.remove
• Remove unused functions from String0
• Use inlining instead of duplication for helpers in Set implementation
• Split out Ocaml_intrinsics_kernel, used it for some intrinsics in Base

Documentation:

• Fix typo where Set.union_list documented itself as union
• Various grammar and capitalization fixes (PR 145, thanks @goodship1)

Tests and benchmarks, largely to gain confidence in the changes above:

• Updated allocation expect tests to actually use let%expect_test (oops)
• Updated benchmarks for Float.clamp*.
• Add benchmarks for Hashtbl.map_inplace, create, remove, set, change, and find_and_remove
• Add benchmarks for Map.set, remove, and change
• Add js_of_ocaml-only benchmarks for Map.remove and Map.change
• Benchmark Sequence.compare and String.index
• Benchmark Set.add, find, and find_map
• Tests and benchmarks for min_elt, max_elt, count, and counti in Array and List

Windows:

• Fixed the windows build. (PR 152, thanks @hhugo)

Work toward compatibility with OCaml 5.1:

• Update Random to use new splittable PRNG
• Other various changes

Improved support for compiler extensions found at https://github.com/ocaml-flambda/flambda-backend:

• Various updated signatures, definitions, and new functionality to support local_ mode and stack allocation
• Added annotations for [@zero_alloc] compiler checks

Release v0.16.0

Changes across many modules:

• Replaced Caml with Stdlib. The Caml module predated Stdlib and has been redundant for some time.

• Added support for local allocations. This is a nonstandard OCaml extension available at https://github.com/ocaml-flambda/ocaml-jst.

  Support includes:

  • updating functions to accept [@local] arguments, especially closures
  • local constructors, like Array.create_local and Bytes.create_local
  • new versions of interfaces supporting local values, such as Applicative.S_local
  • [@@deriving globalize] on some types, for converting local values to global values
• Rename Polymorphic_compare submodules to Comparisons. The former was a misnomer. While the comparisons for a given type are meant to replace polymorphic compare operators, they are not polymorphic themselves.
• Added Container.S_with_creators and Indexed_container.S_with_creators. Used these in container modules such as Array, List, and String. These interfaces standardize functions like map and filter. Along the way, refactored module types in Container and Indexed_container.
• In signatures for fold* functions, renamed accumulator type variables to 'acc for improved readability.
• Added of_string_opt to Int_intf.S.
• Added dequeue_and_ignore_exn to Queue_intf.S.

Changes to individual modules:

• Bool: added select, a primitive using CMOV on architectures that support it.

• Comparable:

  • Added 'a reversed and compare_reversed, to support deriving inverted comparisons, e.g.: [%compare: My_type.t Comparable.reversed]
  • Added Derived2_phantom, similar to Derived_phantom.
  • Made Derived*.comparator_witness types injective.

• Float:

  • Added hyperbolic trig functions acosh, asinh, and atanh to Float.
  • Added Float.of_string_opt.
• Hash_set: Made t injective.

• Hashtbl:

  • Added choose_randomly and choose_randomly_exn.
  • Made Hashtbl.t injective.
• Lazy: Added peek, extracting an already-forced value if present.

• Map:

  • Added split_le_gt, split_lt_ge, and transpose_keys.
  • Added Make_applicative_traversals, allowing some applicatives to improve performance when operating on maps.
  • Corrected documentation of performance for filter* functions.
  • Refactored module types in map_intf.ml. Among other changes, propagated ~comparator argument slightly differently to allow expressing type of transpose_keys properly.
• Monad: Documented performance characteristics of Ident.
• Option: Deprecated functions from Container but not particularly useful for options.
• Ppx_compare_lib: Removed primitive functions; ppx_compare now explicitly refers to these via Stdlib.
• Sequence: Changed Step.t variant type to use inlined records.

• Set:

  • Added of_tree, to_tree, split_le_gt, and split_lt_ge.
  • Created a single shared 'a Named.t type to set_intf.ml, rather than using a new type in every instance of Accessors.
  • Made Set.t injective in both type arguments.
  • Refactored module types in set_intf.ml.
• Sexpable: Of_stringable now provides t_sexp_grammar.
• Sign and Sign_or_nan: Added to_string_hum.
• Stack: added filter, filter_inplace, and filter_map.
• String: added concat_lines, pad_left, pad_right, and unsafe_sub
• Sys: added opaque_identity_global, which forces its argument to be globally allocated.
• Type_equal: Id.Uid now implements Identifiable.S
• Uniform_array: add sort

Old pre-v0.15 changelogs (very likely stale and incomplete)

git version

• Renamed Result.ok_fst to Result.to_either (old name remains as deprecated alias). Added analogous Result.of_either function.
• Removed deprecated values Array.truncate, {Obj_array, Uniform_array}.unsafe_truncate, Result.ok_unit, {Result, Or_error}.ignore.
• Changed the signature of Hashtbl.equal to take the data equality function first, allowing it to be used with [%equal: t].
• Remove deprecated function List.dedup.
• Remove deprecated string mutation functions from the String module.
• Removed deprecated function Monad.all_ignore in favor of Monad.all_unit.
• Deprecated Or_error.ignore and Result.ignore in favor of Or_error.ignore_m and Result.ignore_m.
• Ordered_collection_common.get_pos_len now returns an Or_error.t
• Added Bool.Non_short_circuiting.
• Added Float.square.
• Remove module Or_error.Ok.
• module Ref doesn't implement Container.S1 anymore.
• Rename parameter of Sequence.merge from cmp to compare.
• Added Info.of_lazy_t
• Added List.partition_result function, to partition a list of Result.t values
• Changed the signature of equal from 'a t -> 'a t -> equal:('a -> 'a -> bool) -> bool to ('a -> 'a -> bool) -> 'a t -> 'a t -> bool.
• Optimized Lazy.compare to check physical equality before forcing the lazy values.
• Deprecated Args in the Applicative interface in favor of using ppx_let.
• Deprecated Array.replace arr i ~f in favor of using arr.(i) <- (f (arr.(i)))
• Rename collection length parameter of Ordered_collection_common functions from length to total_length, and add a unit argument to get_pos_len and get_pos_len_exn.
• Removed functions that were deprecated in 2016 from the Array and Set modules.
• Int.Hex.of_string and friends no longer silently ignore a suffix of non-hexadecimal garbage.
• Added ?backtrace argument to Or_error.of_exn_result.
• List.zip now returns a List.Or_unequal_lengths.t instead of an option.
• Remove functions from the Sequence module that were deprecated in 2015.
• Container.Make and Container.Make0 now require callers to either provide a custom length function or request that one be derived from fold. Container.to_array's signature is also changed to accept length and iter instead of fold.
• Exposed module Int_math.