Chris@82: (*
Chris@82:  * Copyright (c) 1997-1999 Massachusetts Institute of Technology
Chris@82:  * Copyright (c) 2003, 2007-14 Matteo Frigo
Chris@82:  * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
Chris@82:  *
Chris@82:  * This program is free software; you can redistribute it and/or modify
Chris@82:  * it under the terms of the GNU General Public License as published by
Chris@82:  * the Free Software Foundation; either version 2 of the License, or
Chris@82:  * (at your option) any later version.
Chris@82:  *
Chris@82:  * This program is distributed in the hope that it will be useful,
Chris@82:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@82:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Chris@82:  * GNU General Public License for more details.
Chris@82:  *
Chris@82:  * You should have received a copy of the GNU General Public License
Chris@82:  * along with this program; if not, write to the Free Software
Chris@82:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
Chris@82:  *
Chris@82:  *)
Chris@82: 
Chris@82: (*************************************************************
Chris@82:  *   Monads
Chris@82:  *************************************************************)
Chris@82: 
Chris@82: (*
Chris@82:  * Phil Wadler has many well written papers about monads.  See
Chris@82:  * http://cm.bell-labs.com/cm/cs/who/wadler/ 
Chris@82:  *)
Chris@82: (* vanilla state monad *)
Chris@82: module StateMonad = struct
Chris@82:   let returnM x = fun s -> (x, s)
Chris@82: 
Chris@82:   let (>>=) = fun m k -> 
Chris@82:     fun s ->
Chris@82:       let (a', s') = m s
Chris@82:       in let (a'', s'') = k a' s'
Chris@82:       in (a'', s'')
Chris@82: 
Chris@82:   let (>>) = fun m k ->
Chris@82:     m >>= fun _ -> k
Chris@82: 
Chris@82:   let rec mapM f = function
Chris@82:       [] -> returnM []
Chris@82:     | a :: b ->
Chris@82: 	f a >>= fun a' ->
Chris@82: 	  mapM f b >>= fun b' ->
Chris@82: 	    returnM (a' :: b')
Chris@82: 
Chris@82:   let runM m x initial_state =
Chris@82:     let (a, _) = m x initial_state
Chris@82:     in a
Chris@82: 
Chris@82:   let fetchState =
Chris@82:     fun s -> s, s
Chris@82: 
Chris@82:   let storeState newState =
Chris@82:     fun _ -> (), newState
Chris@82: end
Chris@82: 
Chris@82: (* monad with built-in memoizing capabilities *)
Chris@82: module MemoMonad =
Chris@82:   struct
Chris@82:     open StateMonad
Chris@82: 
Chris@82:     let memoizing lookupM insertM f k =
Chris@82:       lookupM k >>= fun vMaybe ->
Chris@82: 	match vMaybe with
Chris@82: 	  Some value -> returnM value
Chris@82: 	| None ->
Chris@82: 	    f k >>= fun value ->
Chris@82: 	      insertM k value >> returnM value
Chris@82: 
Chris@82:     let runM initial_state m x  = StateMonad.runM m x initial_state
Chris@82: end