summaryrefslogtreecommitdiff
path: root/src/compiler/scala/tools/nsc/doc/html/resource/template.html
blob: 6bf91d96eec017e0f838f3b61a17f6ad43478e0a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<!DOCTYPE HTML>
<html>
	<head>
		<title>Scaladoc</title>
		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
		<script type="text/javascript" src="lib/jquery.js"></script>
		<style type="text/css">
			@import url("lib/template.css") screen;
		</style>
		<script type="text/javascript" src="lib/template.js"></script>
	</head>
	<body class="type">
		<p id="owner">scala.collection.mutable</p>
		<div id="definition">
			<img src="lib/class_big.png"/>
			<h1>ImmutableMapAdaptor</h1>
		</div>
		<div class="signature">
		    <div class="kind">class</div>
		    <div class="symbol">
		    	<span class="name">ImmutableMapAdaptor</span>
		    	<span class="tparams">[<span name="T">T ⊲ Int</span>,<span name="Y">Y</span>]</span>
		    	<span class="result">extends<span>A[X]</span> with <span>C[Y]</span> with <span>B</span></span>
		    </div>
		</div>
		<div id="comment" class="comment">
			<p>This class can be used as an adaptor to create mutable maps from immutable map implementations. Only method empty has to be redefined if the immutable map on which this mutable map is originally based is not empty. empty is supposed to return the representation of an empty map.</p>
			<p>A subtrait of collection.IndexedSeq which represents sequences that can be mutated.</p>
			<p>The canonical builder for collections that are addable, i.e. that support an efficient + method which adds an element to the collection. Collections are <code>built</code> from their empty element using this + method.</p>
			<code class="block">
				Once upon a time<br/>
				In a land far far away<br/>
				There was a man
			</code>
		</div>
		<div id="template">
			<div id="mbrsel">
				<div id="ancestors">
					<h3>Inherits</h3>
					<ol>
						<li class="in" name="scala.ImmutableMapAdaptor">ImmutableMapAdaptor</li>
						<li class="in" name="toto.FlawedImpl">FlawedImpl</li>
						<li class="in" name="Map">Map</li>
						<li class="in" name="ImmutableThingy">ImmutableThingy</li>
						<li class="in" name="scala.AnyRef">AnyRef</li>
						<li class="in" name="scala.Any">Any</li></ol>
				</div>
				<div id="implicits">
					<h3>Implicitly</h3>
					<ol><li class="out" name="RichAdaptor">RichAdaptor</li><li class="in" name="RaptureFallback">RaptureFallback</li></ol>
				</div>
			</div>
			<div id="values" class="members">
				<h3>Value Members</h3>
				<ol>
					<li name="toto.FlawedImpl#transform">
						<div class="signature">
							<div class="kind">def</div>
							<div class="symbol">
								<span class="name">transform</span>
								<span class="tparams">[<span name="T">T</span>, <span name="U">U ⊲ Int</span>]</span>
								<span class="params">(<span name="f">f: (A, B) => B</span>, <span name="b">b: <span class="extype" name="scala.Double">Double</span></span>)</span>
								<span class="result">:<span>ImmutableMapAdaptor[A, B]</span></span>
							</div>
						</div>
						<ol class="paramcmts">
							<li class="tparam" name="T">
								<p>T an empty map.</p>
							</li>
							<li class="tparam" name="U">
								<p>U can be used as an adaptor to create mutable maps.</p>
							</li>
							<li class="param" name="f">
								<p>f can be used as an adaptor to create mutable maps from immutable map implementations. Only method empty has to be redefined.</p>
							</li>
							<li class="param" name="b">
								<p>b the immutable map on which this mutable map is originally based is not empty. empty is supposed to return the representation of an empty map.</p>
							</li>
						</ol>
						<ol class="attributes"><li>override</li><li>protected</li><li>@inline</li></ol>
						<div class="comment">
							<p>A subtrait of collection.IndexedSeq which represents sequences that can be mutated.</p>
							<p>The canonical builder for collections that are addable, i.e. that support an efficient + method which adds an element to the collection. Collections are built from their empty element using this + method.</p>
						</div>
					</li>
					<li name="Map#curry">
						<div class="signature">
							<div class="kind">def</div>
							<div class="symbol">
								<span class="name">curry</span>
								<span class="params">(<span name="f">f: (A, B) => B</span>, <span name="b">b: Double</span>)</span><span class="params">(<span name="g">g: Int => B</span>, <span name="c">c: Double</span>)</span><span class="result">: <span>ImmutableMapAdaptor[A, B]</span></span>
							</div>
						</div>
					</li>
					<li name="randomize">
						<div class="signature">
							<div class="kind">val</div>
							<div class="symbol">
								<span class="name">randomize</span><span class="result">: <span>ImmutableMapAdaptor[A, B]</span></span>
							</div>
						</div>
						<div class="comment">
							<p>A subtrait of collection.IndexedSeq which represents sequences that can be mutated.</p>
							<p>The canonical builder for collections that are addable, i.e. that support an efficient + method which adds an element to the collection. Collections are built from their empty element using this + method.</p>
						</div>
					</li>
					<li>
						<div class="signature">
							<div class="kind">object</div>
							<div class="symbol">
								<span class="name">babar</span>
							</div>
						</div>
					</li>
					<li>
						<div class="signature">
							<div class="kind">package</div>
							<div class="symbol">
								<span class="name">fantomette</span>
							</div>
						</div>
						<div class="comment">
							<p>A subtrait of collection.IndexedSeq which represents sequences that can be mutated.</p>
							<p>The canonical builder for collections that are addable, i.e. that support an efficient + method which adds an element to the collection. Collections are built from their empty element using this + method.</p>
						</div>
					</li>
				</ol>
			</div>
			<div id="types" class="members">
				<h3>Type Members</h3>
				<ol>
					<li>
						<div class="signature">
							<div class="kind">type</div>
							<div class="symbol">
								<span class="name">T</span>
								<span class="tparams">[<span name="T">T</span>,<span name="U">U ⊲ Int</span>]</span>
							</div>
						</div>
						<div class="comment">
							<p>A subtrait of collection.IndexedSeq which represents sequences that can be mutated.</p>
						</div>
					</li>
					<li>
						<a class="signature" href="RandomAccessWaste">
							<div class="kind">class</div>
							<div class="symbol">
								<span class="name">RandomAccessWaste</span>
								<span class="tparams">[<span name="T">T</span>,<span name="U">U ⊲ Int</span>]</span>
							</div>
						</a>
						<div class="comment">
							<p>Some inner class</p>
						</div>
					</li>
					<li>
						<div class="signature">
							<div class="kind">[]</div>
							<div class="symbol">
								<span class="name">Y</span>
								<span class="result"><span>Int</span><span>Nothing</span></span>
							</div>
						</div>
					</li>
					<li>
						<div class="signature">
							<div class="kind">[]</div>
							<div class="symbol">
								<span class="name">X</span>
							</div>
						</div>
						<div class="comment">
							<p>Some type parameter</p>
						</div>
					</li>
					<li>
						<div class="signature">
							<div class="kind">[]</div>
							<div class="symbol">
								<span class="name">Y</span>
								<span class="result"><span>Int</span><span>Nothing</span></span>
							</div>
						</div>
					</li>
					<li>
						<div class="signature">
							<span class="kind">type</span>
							<span class="symbol">
								<span class="name">U</span>
								<span class="result">=<span><a href="">ImmutableMapAdaptor</a>[A, B]</span></span>
							</span>
						</div>
					</li>
					<li name="scala.CountedIterator">
      					<a href="CountedIterator.html" class="signature">
      						<span class="kind">trait</span>
      						<span class="symbol">
        						<span class="name">CountedIterator</span>
        						<span class="tparams">[<span name="A">+A</span>]</span>
        						<span class="result">extends Iterator[A]</span>
      						</span>
        				</a>
      					<div class="comment">
      						<p>Counted iterators keep track of the number of elements seen so far</p>
						</div>
    				</li>
					<li>
						<div class="signature">
							<div class="kind">type</div>
							<div class="symbol">
								<span class="name">V</span>
								<span class="result">⊲ Int ⊳ Boolean</span>
							</div>
						</div>
						<div class="comment">
							<p>A subtrait of collection.IndexedSeq which represents sequences that can be mutated.</p>
						</div>
					</li>
				</ol>
			</div>
			<div id="constructors" class="members">
				<h3>Constructors</h3>
				<ol>
					<li>
						<div class="signature">
							<div class="kind">new</div>
							<div class="symbol">
								<span class="name">ImmutableMapAdaptor</span>
								<span class="tparams">[<span name="T">T</span>,<span name="U">U ⊲ Int</span>]</span>
								<span class="params">(<span name="f">f: (A, B) => B</span>,<span name="b">b: Double</span>)</span>
							</div>
						</div>
						<div class="comment">
							<p>A subtrait of collection.IndexedSeq which represents sequences that can be mutated.</p>
						</div>
					</li>
				</ol>
			</div>
		</div>
	</body>
</html>