lazyStream

Short Description

Like Seq and Stream but more lazily evaluated, though calling a function with the same parameters multiple times will create different streams and will be evaluated separately, and more provided functions

Documentation

The documentation for the LazyStream module is present here: LazyStream documentation.

Installation

There are a few ways in which you can use this package:

Using it only in your local project

Clone this repository in your workspace directory where the workspace path is [workspace_path]:

cd [workspace_path]
git clone https://github.com/nik312123/lazyStream.git

1. If your project is a dune project:

Ensure that your workspace has a structure that matches something like one of the below structures:

Outer-most possible structure:

workspace_dir/
    dune
    dune-project
    example.ml
    example2.ml
    ...

The .ml files in which you need to use the library can be nested as far as you would like as in the following:

workspace_dir/
    dune
    dune-project
    project_subdir/
        dune
        example.ml
        example2.ml

Then, in the dune file corresponding to the .ml file(s) in question, you can add lazyStream in the libraries section like in the following:

(executable
    (name example)
    (libraries lazyStream))

2. If your project is built using ocamlbuild

When building using ocamlbuild, include the library directory in the locations to search for dependencies.

Example:

If [example_path] is the path for example.ml and [lazyStream_path] is the path for lazyStream.ml where both paths are subdirectories of the workspace directory, then the following would be the command to build example.byte using the LazyStream module:

ocamlbuild -use-ocamlfind -I [example_path] -I [lazyStream_path] example.byte

Installing it in your opam switch and using it in a project

Clone the repository wherever you would like:

git clone https://github.com/nik312123/lazyStream.git

Go into the directory you just cloned:

cd lazyStream

Install the library using opam:

opam install .

1. If your project is a dune project:

Then, in the dune file corresponding to the .ml file(s) in question, you can add lazyStream in the libraries section like in the following:

(executable
    (name example)
    (libraries lazyStream))

2. If your project is built using ocamlbuild

When building using ocamlbuild, include the library in your packages.

Example:

ocamlbuild -pkgs lazyStream example.byte

Terms of Use

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

Please review COPYING and COPYING.LESSER to understand the terms of use.