package knights_tour

  1. Overview
  2. Docs
package knights_tour
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module type Dlist_itf.SSource

type 'a t

A 'a t is a Dlist containing elements of type 'a. A Dlist, short for double-ended list, is a purely functional ordered list of elements that can be accessed both from the front and the back.

val name : string

A name for the datatype, there are different implementations of this interface, you can check this name to identify which implementation you are using.

val empty : 'a t

An empty Dlist, contains no elements.

val is_empty : 'a t -> bool

is_empty t is true iff there are no elements in t.

val map : ('a -> 'b) -> 'a t -> 'b t

map f t applies a function to each element of t, creating a new Dlist with the results.

val singleton : 'a -> 'a t

Creates a Dlist containing a single element.

val size : 'a t -> int

size t returns the number of elements in t. This operation is O(1).

val push : 'a -> 'a t -> 'a t

push el t Adds an element to the front of t.

val pop : 'a t -> ('a * 'a t) option

pop el t Removes an element from the front of t.

val push_end : 'a -> 'a t -> 'a t

push_end el t Adds an element to the end of t.

val pop_end : 'a t -> ('a * 'a t) option

pop_end el t Removes an element from the end of t.

val append : 'a t -> 'a t -> 'a t

append s1 s2 Creates Dlist that contains all elements of s1 followed by all elements of s2.

val of_list : 'a list -> 'a t

of_list elements Creates a Dlist from the elements of the list. The front of the list will become the front ot the Dlist. The first element you pop from the Dlist will be the first element in the list.

val to_string : ('a -> string) -> 'a t -> string

Converts Dlist into a string revealing its internal structure. Useful for debugging and testing.

val get : int -> 'a t -> 'a

get i s finds element at index i from the front. For example get 0 s is equivalent pop s

val to_list : 'a t -> 'a list

to_list s converts a Dlist into a list by popping all elements from the front.