<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>src/TensorFlow/Queue.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-- Copyright 2016 TensorFlow authors.</span>
<a name="line-2"></a><span class='hs-comment'>--</span>
<a name="line-3"></a><span class='hs-comment'>-- Licensed under the Apache License, Version 2.0 (the "License");</span>
<a name="line-4"></a><span class='hs-comment'>-- you may not use this file except in compliance with the License.</span>
<a name="line-5"></a><span class='hs-comment'>-- You may obtain a copy of the License at</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>--     <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- Unless required by applicable law or agreed to in writing, software</span>
<a name="line-10"></a><span class='hs-comment'>-- distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="line-11"></a><span class='hs-comment'>-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="line-12"></a><span class='hs-comment'>-- See the License for the specific language governing permissions and</span>
<a name="line-13"></a><span class='hs-comment'>-- limitations under the License.</span>
<a name="line-14"></a>
<a name="line-15"></a><span class='hs-comment'>{-# LANGUAGE OverloadedStrings #-}</span>
<a name="line-16"></a><span class='hs-comment'>{-# LANGUAGE ScopedTypeVariables #-}</span>
<a name="line-17"></a>
<a name="line-18"></a><span class='hs-comment'>-- | Queues in TensorFlow graph. Very limited support for now.</span>
<a name="line-19"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>TensorFlow</span><span class='hs-varop'>.</span><span class='hs-conid'>Queue</span> <span class='hs-layout'>(</span><span class='hs-conid'>Queue2</span><span class='hs-layout'>,</span> <span class='hs-varid'>makeQueue2</span><span class='hs-layout'>,</span> <span class='hs-varid'>enqueue</span><span class='hs-layout'>,</span> <span class='hs-varid'>dequeue</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-20"></a>
<a name="line-21"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span>
<a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Int</span> <span class='hs-layout'>(</span><span class='hs-conid'>Int64</span><span class='hs-layout'>)</span>
<a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Lens</span><span class='hs-varop'>.</span><span class='hs-conid'>Family2</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varop'>.~</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>&amp;</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>TensorFlow</span><span class='hs-varop'>.</span><span class='hs-conid'>Build</span> <span class='hs-layout'>(</span><span class='hs-conid'>ControlNode</span><span class='hs-layout'>,</span> <span class='hs-conid'>Build</span><span class='hs-layout'>,</span> <span class='hs-varid'>addInitializer</span><span class='hs-layout'>,</span> <span class='hs-varid'>opAttr</span><span class='hs-layout'>,</span> <span class='hs-varid'>opDef</span><span class='hs-layout'>)</span>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>TensorFlow</span><span class='hs-varop'>.</span><span class='hs-conid'>BuildOp</span> <span class='hs-layout'>(</span><span class='hs-varid'>buildOp</span><span class='hs-layout'>)</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>TensorFlow</span><span class='hs-varop'>.</span><span class='hs-conid'>ControlFlow</span> <span class='hs-layout'>(</span><span class='hs-varid'>group</span><span class='hs-layout'>)</span>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>TensorFlow</span><span class='hs-varop'>.</span><span class='hs-conid'>Tensor</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ref</span><span class='hs-layout'>,</span> <span class='hs-conid'>Tensor</span><span class='hs-layout'>)</span>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>TensorFlow</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span><span class='hs-conid'>TensorType</span><span class='hs-layout'>,</span> <span class='hs-varid'>tensorType</span><span class='hs-layout'>)</span>
<a name="line-29"></a>
<a name="line-30"></a><a name="Queue2"></a><span class='hs-comment'>-- | A queue carrying tuples. The underlying structure is more</span>
<a name="line-31"></a><a name="Queue2"></a><span class='hs-comment'>-- versatile and can be made to support arbitrary tuples.</span>
<a name="line-32"></a><a name="Queue2"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Queue2</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Queue2</span> <span class='hs-layout'>{</span> <span class='hs-varid'>handle</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Handle</span> <span class='hs-layout'>}</span>
<a name="line-33"></a>
<a name="line-34"></a><a name="Handle"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Handle</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Tensor</span> <span class='hs-conid'>Ref</span> <span class='hs-conid'>ByteString</span>
<a name="line-35"></a>
<a name="line-36"></a><a name="enqueue"></a><span class='hs-comment'>-- | Adds the given values to the queue.</span>
<a name="line-37"></a><span class='hs-definition'>enqueue</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyword'>forall</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-varid'>v1</span> <span class='hs-varid'>v2</span><span class='hs-varop'>.</span> <span class='hs-layout'>(</span><span class='hs-conid'>TensorType</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>TensorType</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-38"></a>           <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>Queue2</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span>
<a name="line-39"></a>           <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Tensor</span> <span class='hs-varid'>v1</span> <span class='hs-varid'>a</span>
<a name="line-40"></a>           <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Tensor</span> <span class='hs-varid'>v2</span> <span class='hs-varid'>b</span>
<a name="line-41"></a>           <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Build</span> <span class='hs-conid'>ControlNode</span>
<a name="line-42"></a><span class='hs-definition'>enqueue</span> <span class='hs-varid'>q</span> <span class='hs-keyglyph'>=</span>
<a name="line-43"></a>    <span class='hs-varid'>buildOp</span> <span class='hs-layout'>(</span><span class='hs-varid'>opDef</span> <span class='hs-str'>"QueueEnqueue"</span>
<a name="line-44"></a>             <span class='hs-varop'>&amp;</span> <span class='hs-varid'>opAttr</span> <span class='hs-str'>"Tcomponents"</span> <span class='hs-varop'>.~</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>tensorType</span> <span class='hs-layout'>(</span><span class='hs-varid'>undefined</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-45"></a>                                       <span class='hs-layout'>,</span> <span class='hs-varid'>tensorType</span> <span class='hs-layout'>(</span><span class='hs-varid'>undefined</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-46"></a>    <span class='hs-layout'>(</span><span class='hs-varid'>handle</span> <span class='hs-varid'>q</span><span class='hs-layout'>)</span>
<a name="line-47"></a>
<a name="line-48"></a><a name="dequeue"></a><span class='hs-comment'>-- | Retrieves the values from the queue.</span>
<a name="line-49"></a><span class='hs-definition'>dequeue</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyword'>forall</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-varop'>.</span> <span class='hs-layout'>(</span><span class='hs-conid'>TensorType</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>TensorType</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-50"></a>           <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>Queue2</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span>
<a name="line-51"></a>           <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Build</span> <span class='hs-layout'>(</span><span class='hs-conid'>Tensor</span> <span class='hs-conid'>Ref</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Tensor</span> <span class='hs-conid'>Ref</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-52"></a>           <span class='hs-comment'>-- ^ Dequeued tensors. They are paired in a sense</span>
<a name="line-53"></a>           <span class='hs-comment'>-- that values appear together, even if they are</span>
<a name="line-54"></a>           <span class='hs-comment'>-- not consumed together.</span>
<a name="line-55"></a><span class='hs-definition'>dequeue</span> <span class='hs-varid'>q</span> <span class='hs-keyglyph'>=</span>
<a name="line-56"></a>    <span class='hs-varid'>buildOp</span> <span class='hs-layout'>(</span><span class='hs-varid'>opDef</span> <span class='hs-str'>"QueueDequeue"</span>
<a name="line-57"></a>             <span class='hs-varop'>&amp;</span> <span class='hs-varid'>opAttr</span> <span class='hs-str'>"component_types"</span> <span class='hs-varop'>.~</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>tensorType</span> <span class='hs-layout'>(</span><span class='hs-varid'>undefined</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-58"></a>                                           <span class='hs-layout'>,</span> <span class='hs-varid'>tensorType</span> <span class='hs-layout'>(</span><span class='hs-varid'>undefined</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-59"></a>    <span class='hs-layout'>(</span><span class='hs-varid'>handle</span> <span class='hs-varid'>q</span><span class='hs-layout'>)</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="makeQueue2"></a><span class='hs-comment'>-- | Creates a new queue with the given capacity and shared name.</span>
<a name="line-62"></a><span class='hs-definition'>makeQueue2</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyword'>forall</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span> <span class='hs-varop'>.</span> <span class='hs-layout'>(</span><span class='hs-conid'>TensorType</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>TensorType</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-63"></a>              <span class='hs-keyglyph'>=&gt;</span> <span class='hs-conid'>Int64</span>  <span class='hs-comment'>-- ^ The upper bound on the number of elements in</span>
<a name="line-64"></a>                        <span class='hs-comment'>--  this queue. Negative numbers mean no limit.</span>
<a name="line-65"></a>              <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>ByteString</span> <span class='hs-comment'>-- ^ If non-empty, this queue will be shared</span>
<a name="line-66"></a>                            <span class='hs-comment'>-- under the given name across multiple sessions.</span>
<a name="line-67"></a>              <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Build</span> <span class='hs-layout'>(</span><span class='hs-conid'>Queue2</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span>
<a name="line-68"></a><span class='hs-definition'>makeQueue2</span> <span class='hs-varid'>capacity</span> <span class='hs-varid'>sharedName</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-69"></a>    <span class='hs-varid'>q</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>buildOp</span> <span class='hs-layout'>(</span><span class='hs-varid'>opDef</span> <span class='hs-str'>"FIFOQueue"</span>
<a name="line-70"></a>                     <span class='hs-varop'>&amp;</span> <span class='hs-varid'>opAttr</span> <span class='hs-str'>"component_types"</span> <span class='hs-varop'>.~</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>tensorType</span> <span class='hs-layout'>(</span><span class='hs-varid'>undefined</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-71"></a>                                                   <span class='hs-layout'>,</span> <span class='hs-varid'>tensorType</span> <span class='hs-layout'>(</span><span class='hs-varid'>undefined</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-72"></a>                     <span class='hs-varop'>&amp;</span> <span class='hs-varid'>opAttr</span> <span class='hs-str'>"shared_name"</span> <span class='hs-varop'>.~</span> <span class='hs-varid'>sharedName</span>
<a name="line-73"></a>                     <span class='hs-varop'>&amp;</span> <span class='hs-varid'>opAttr</span> <span class='hs-str'>"capacity"</span> <span class='hs-varop'>.~</span> <span class='hs-varid'>capacity</span>
<a name="line-74"></a>                    <span class='hs-layout'>)</span>
<a name="line-75"></a>    <span class='hs-varid'>group</span> <span class='hs-varid'>q</span> <span class='hs-varop'>&gt;&gt;=</span> <span class='hs-varid'>addInitializer</span>
<a name="line-76"></a>    <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>Queue2</span> <span class='hs-varid'>q</span><span class='hs-layout'>)</span>
<a name="line-77"></a>
<a name="line-78"></a><span class='hs-comment'>-- TODO(gnezdo): Figure out the closing story for queues.</span>
</pre></body>
</html>