Skip to content

Instantly share code, notes, and snippets.

@jpsim

jpsim/Alamofire.xml

Created October 14, 2014 21:06
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jpsim/249c167420e6a50c81dc to your computer and use it in GitHub Desktop.
Save jpsim/249c167420e6a50c81dc to your computer and use it in GitHub Desktop.
Download ZIP
SourceKitten Output
Raw
Alamofire.xml
<jazzy>
<Other column="12" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="26">
<Name>AlamofireErrorDomain</Name>
<USR>s:v9Alamofire20AlamofireErrorDomainSS</USR>
<Declaration>public let AlamofireErrorDomain: String</Declaration>
<Abstract>
<Para>Alamofire errors</Para>
</Abstract>
</Other>
<Other column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="33">
<Name>Method</Name>
<USR>s:O9Alamofire6Method</USR>
<Declaration>public enum Method : String</Declaration>
<Abstract>
<Para>HTTP method definitions.</Para>
</Abstract>
<Discussion>
<Para>See http://tools.ietf.org/html/rfc7231#section-4.3</Para>
</Discussion>
</Other>
<Other column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="48">
<Name>ParameterEncoding</Name>
<USR>s:O9Alamofire17ParameterEncoding</USR>
<Declaration>public enum ParameterEncoding</Declaration>
<Abstract>
<Para>Used to specify the way in which a set of parameters are applied to a URL request.</Para>
</Abstract>
</Other>
<Other column="10" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="52">
<Name>URL</Name>
<USR>s:FO9Alamofire17ParameterEncoding3URLFMS0_S0_</USR>
<Declaration/>
<Abstract>
<Para>A query string to be set as or appended to any existing URL query for `GET`, `HEAD`, and `DELETE` requests, or set as the body for requests with any other HTTP method. The `Content-Type` HTTP header field of an encoded request with HTTP body is set to `application/x-www-form-urlencoded`. Since there is no published specification for how to encode collection types, the convention of appending `[]` to the key for array values (`foo[]=1&amp;foo[]=2`), and appending the key surrounded by square brackets for nested dictionary values (`foo[bar]=baz`).</Para>
</Abstract>
</Other>
<Other column="10" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="57">
<Name>JSON</Name>
<USR>s:FO9Alamofire17ParameterEncoding4JSONFMS0_S0_</USR>
<Declaration/>
<Abstract>
<Para>Uses `NSJSONSerialization` to create a JSON representation of the parameters object, which is set as the body of the request. The `Content-Type` HTTP header field of an encoded request is set to `application/json`.</Para>
</Abstract>
</Other>
<Other column="10" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="62">
<Name>PropertyList</Name>
<USR>s:FO9Alamofire17ParameterEncoding12PropertyListFMS0_FTOSC20NSPropertyListFormatSi_S0_</USR>
<Declaration/>
<Abstract>
<Para>Uses `NSPropertyListSerialization` to create a plist representation of the parameters object, according to the associated format and write options values, which is set as the body of the request. The `Content-Type` HTTP header field of an encoded request is set to `application/x-plist`.</Para>
</Abstract>
</Other>
<Other column="10" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="67">
<Name>Custom</Name>
<USR>s:FO9Alamofire17ParameterEncoding6CustomFMS0_FFTPS_21URLRequestConvertible_GSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__S0_</USR>
<Declaration/>
<Abstract>
<Para>Uses the associated closure value to construct a new request given an existing request and parameters.</Para>
</Abstract>
</Other>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="77">
<Name>encode(_:parameters:)</Name>
<USR>s:FO9Alamofire17ParameterEncoding6encodeFS0_FTPS_21URLRequestConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__</USR>
<Declaration>public func encode(URLRequest: URLRequestConvertible, parameters: [String : AnyObject]?) -&gt; (NSURLRequest, NSError?)</Declaration>
<Abstract>
<Para>Creates a URL request by encoding parameters and applying them onto an existing request.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>URLRequest</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The request to have parameters applied</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>parameters</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The parameters to apply</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>A tuple containing the constructed request and the error that occurred during parameter encoding, if any.</Para>
</ResultDiscussion>
</Function>
<Class column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="198">
<Name>URLRequestConvertible</Name>
<USR>s:P9Alamofire21URLRequestConvertible</USR>
<Declaration>public protocol URLRequestConvertible</Declaration>
<Abstract>
<Para>Types adopting the `URLRequestConvertible` protocol can be used to construct URL requests.</Para>
</Abstract>
</Class>
<Other column="9" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="200">
<Name>URLRequest</Name>
<USR>s:vP9Alamofire21URLRequestConvertible10URLRequestCSo12NSURLRequest</USR>
<Declaration>var URLRequest: NSURLRequest { get }</Declaration>
<Abstract>
<Para>The URL request.</Para>
</Abstract>
</Other>
<Class column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="164">
<Name>URLStringConvertible</Name>
<USR>s:P9Alamofire20URLStringConvertible</USR>
<Declaration>public protocol URLStringConvertible</Declaration>
<Abstract>
<Para>Types adopting the `URLStringConvertible` protocol can be used to construct URL strings, which are then used to construct URL requests.</Para>
</Abstract>
</Class>
<Other column="9" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="166">
<Name>URLString</Name>
<USR>s:vP9Alamofire20URLStringConvertible9URLStringSS</USR>
<Declaration>var URLString: String { get }</Declaration>
<Abstract>
<Para>The URL string.</Para>
</Abstract>
</Other>
<Class column="14" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="214">
<Name>Manager</Name>
<USR>s:C9Alamofire7Manager</USR>
<Declaration>public class Manager</Declaration>
<Abstract>
<Para>Responsible for creating and managing `Request` objects, as well as their underlying `NSURLSession`.</Para>
</Abstract>
</Class>
<Other column="22" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="219">
<Name>sharedInstance</Name>
<USR>s:vC9Alamofire7Manager14sharedInstanceS0_</USR>
<Declaration>public class var sharedInstance: Manager { get }</Declaration>
<Abstract>
<Para>A shared instance of `Manager`, used by top-level Alamofire request methods, and suitable for use directly for any ad hoc requests.</Para>
</Abstract>
</Other>
<Function column="21" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="286">
<Name>init(configuration:)</Name>
<USR>s:FC9Alamofire7ManagercFMS0_FT13configurationGSqCSo25NSURLSessionConfiguration__S0_</USR>
<Declaration>required public init(configuration: NSURLSessionConfiguration? = default)</Declaration>
<Parameters>
<Parameter>
<Name>configuration</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The configuration used to construct the managed session.</Para>
</Discussion>
</Parameter>
</Parameters>
</Function>
<Other column="16" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="278">
<Name>session</Name>
<USR>s:vC9Alamofire7Manager7sessionCSo12NSURLSession</USR>
<Declaration>public let session: NSURLSession</Declaration>
<Abstract>
<Para>The underlying session.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="281">
<Name>startRequestsImmediately</Name>
<USR>s:vC9Alamofire7Manager24startRequestsImmediatelySb</USR>
<Declaration>public var startRequestsImmediately: Bool</Declaration>
<Abstract>
<Para>Whether to start requests immediately after being constructed. `true` by default.</Para>
</Abstract>
</Other>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="306">
<Name>request(_:)</Name>
<USR>s:FC9Alamofire7Manager7requestFS0_FPS_21URLRequestConvertible_CS_7Request</USR>
<Declaration>public func request(URLRequest: URLRequestConvertible) -&gt; Request</Declaration>
<Abstract>
<Para>Creates a request for the specified URL request.</Para>
</Abstract>
<Discussion>
<Para>If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>URLRequest</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL request</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created request.</Para>
</ResultDiscussion>
</Function>
<Class column="14" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="506">
<Name>Request</Name>
<USR>s:C9Alamofire7Request</USR>
<Declaration>public class Request</Declaration>
<Abstract>
<Para>Responsible for sending a request and receiving the response and associated data from the server, as well as managing its underlying `NSURLSessionTask`.</Para>
</Abstract>
</Class>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="652">
<Name>resume()</Name>
<USR>s:FC9Alamofire7Request6resumeFS0_FT_T_</USR>
<Declaration>public func resume()</Declaration>
<Abstract>
<Para>Resumes the request.</Para>
</Abstract>
</Function>
<Other column="16" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="510">
<Name>task</Name>
<USR>s:vC9Alamofire7Request4taskCSo16NSURLSessionTask</USR>
<Declaration>public var task: NSURLSessionTask { get }</Declaration>
<Abstract>
<Para>The underlying task.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="513">
<Name>session</Name>
<USR>s:vC9Alamofire7Request7sessionCSo12NSURLSession</USR>
<Declaration>public let session: NSURLSession</Declaration>
<Abstract>
<Para>The session belonging to the underlying task.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="516">
<Name>request</Name>
<USR>s:vC9Alamofire7Request7requestCSo12NSURLRequest</USR>
<Declaration>public var request: NSURLRequest { get }</Declaration>
<Abstract>
<Para>The request sent or to be sent to the server.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="519">
<Name>response</Name>
<USR>s:vC9Alamofire7Request8responseGSqCSo17NSHTTPURLResponse_</USR>
<Declaration>public var response: NSHTTPURLResponse? { get }</Declaration>
<Abstract>
<Para>The response received from the server, if any.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="522">
<Name>progress</Name>
<USR>s:vC9Alamofire7Request8progressGSqCSo10NSProgress_</USR>
<Declaration>public var progress: NSProgress? { get }</Declaration>
<Abstract>
<Para>The progress of the request lifecycle.</Para>
</Abstract>
</Other>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="549">
<Name>authenticate(user:password:)</Name>
<USR>s:FC9Alamofire7Request12authenticateFDS0_FT4userSS8passwordSS_DS0_</USR>
<Declaration>public func authenticate(#user: String, password: String) -&gt; Self</Declaration>
<Abstract>
<Para>Associates an HTTP Basic credential with the request.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>user</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The user.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>password</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The password.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="562">
<Name>authenticate(usingCredential:)</Name>
<USR>s:FC9Alamofire7Request12authenticateFDS0_FT15usingCredentialCSo15NSURLCredential_DS0_</USR>
<Declaration>public func authenticate(usingCredential credential: NSURLCredential) -&gt; Self</Declaration>
<Abstract>
<Para>Associates a specified credential with the request.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>credential</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The credential.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="580">
<Name>progress(closure:)</Name>
<USR>s:FC9Alamofire7Request8progressFDS0_FT7closureGSqFTVSs5Int64S1_S1__T___DS0_</USR>
<Declaration>public func progress(closure: ((Int64, Int64, Int64) -&gt; Void)? = default) -&gt; Self</Declaration>
<Abstract>
<Para>Sets a closure to be called periodically during the lifecycle of the request as data is written to or read from the server.</Para>
</Abstract>
<Discussion>
<Para>For uploads, the progress closure returns the bytes written, total bytes written, and total bytes expected to write.For downloads, the progress closure returns the bytes read, total bytes read, and total bytes expected to write.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>closure</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The code to be executed periodically during the lifecycle of the request.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Other column="22" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="597">
<Name>Serializer</Name>
<USR>s:C9Alamofire7Request10Serializer</USR>
<Declaration>public typealias Serializer = (NSURLRequest, NSHTTPURLResponse?, NSData?) -&gt; (AnyObject?, NSError?)</Declaration>
<Abstract>
<Para>A closure used by response handlers that takes a request, response, and data and returns a serialized object and any error that occured in the process.</Para>
</Abstract>
</Other>
<Function column="23" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="604">
<Name>responseDataSerializer()</Name>
<USR>s:FC9Alamofire7Request22responseDataSerializerFMS0_FT_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__</USR>
<Declaration>public class func responseDataSerializer() -&gt; Serializer</Declaration>
<Abstract>
<Para>Creates a response serializer that returns the associated data as-is.</Para>
</Abstract>
<ResultDiscussion>
<Para>A data response serializer.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="617">
<Name>response(_:)</Name>
<USR>s:FC9Alamofire7Request8responseFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_</USR>
<Declaration>public func response(completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</Declaration>
<Abstract>
<Para>Adds a handler to be called once the request has finished.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>completionHandler</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The code to be executed once the request has finished.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="630">
<Name>response(queue:serializer:completionHandler:)</Name>
<USR>s:FC9Alamofire7Request8responseFDS0_FT5queueGSqCSo8NSObject_10serializerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__17completionHandlerFTS2_GSqS3__GSqPS5___GSqS6___T__DS0_</USR>
<Declaration>public func response(queue: dispatch_queue_t? = default, serializer: Serializer, completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</Declaration>
<Abstract>
<Para>Adds a handler to be called once the request has finished.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>queue</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The queue on which the completion handler is dispatched.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>serializer</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The closure responsible for serializing the request, response, and data.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>completionHandler</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The code to be executed once the request has finished.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="645">
<Name>suspend()</Name>
<USR>s:FC9Alamofire7Request7suspendFS0_FT_T_</USR>
<Declaration>public func suspend()</Declaration>
<Abstract>
<Para>Suspends the request.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="659">
<Name>cancel()</Name>
<USR>s:FC9Alamofire7Request6cancelFS0_FT_T_</USR>
<Declaration>public func cancel()</Declaration>
<Abstract>
<Para>Cancels the request.</Para>
</Abstract>
</Function>
<Other column="22" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="822">
<Name>Validation</Name>
<USR>s:C9Alamofire7Request10Validation</USR>
<Declaration>public typealias Validation = (NSURLRequest, NSHTTPURLResponse) -&gt; (Bool)</Declaration>
<Abstract>
<Para>A closure used to validate a request that takes a URL request and URL response, and returns whether the request was valid.</Para>
</Abstract>
</Other>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="833">
<Name>validate(_:)</Name>
<USR>s:FC9Alamofire7Request8validateFDS0_FFTCSo12NSURLRequestCSo17NSHTTPURLResponse_SbDS0_</USR>
<Declaration>public func validate(validation: Validation) -&gt; Self</Declaration>
<Abstract>
<Para>Validates the request, using the specified closure.</Para>
</Abstract>
<Discussion>
<Para>If validation fails, subsequent calls to response handlers will have an associated error.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>validation</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>A closure to validate the request.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="860">
<Name>validate(statusCode:)</Name>
<USR>s:FC9Alamofire7Request8validateFDS0_FT10statusCodeGVSs5RangeSi__DS0_</USR>
<Declaration>public func validate(statusCode range: Range&lt;Int&gt;) -&gt; Self</Declaration>
<Abstract>
<Para>Validates that the response has a status code in the specified range.</Para>
</Abstract>
<Discussion>
<Para>If validation fails, subsequent calls to response handlers will have an associated error.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>range</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The range of acceptable status codes.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="875">
<Name>validate(statusCode:)</Name>
<USR>s:FC9Alamofire7Request8validateFDS0_FT10statusCodeGSaSi__DS0_</USR>
<Declaration>public func validate(statusCode array: [Int]) -&gt; Self</Declaration>
<Abstract>
<Para>Validates that the response has a status code in the specified array.</Para>
</Abstract>
<Discussion>
<Para>If validation fails, subsequent calls to response handlers will have an associated error.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>array</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The acceptable status codes.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="926">
<Name>validate(contentType:)</Name>
<USR>s:FC9Alamofire7Request8validateFDS0_FT11contentTypeGSaSS__DS0_</USR>
<Declaration>public func validate(contentType array: [String]) -&gt; Self</Declaration>
<Abstract>
<Para>Validates that the response has a content type in the specified array.</Para>
</Abstract>
<Discussion>
<Para>If validation fails, subsequent calls to response handlers will have an associated error.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>contentType</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The acceptable content types, which may specify wildcard types and/or subtypes.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="941">
<Name>validate()</Name>
<USR>s:FC9Alamofire7Request8validateFDS0_FT_DS0_</USR>
<Declaration>public func validate() -&gt; Self</Declaration>
<Abstract>
<Para>Validates that the response has a status code in the default acceptable range of 200...299, and that the content type matches any specified in the Accept HTTP header field.</Para>
</Abstract>
<Discussion>
<Para>If validation fails, subsequent calls to response handlers will have an associated error.</Para>
</Discussion>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1004">
<Name>upload(_:file:)</Name>
<USR>s:FC9Alamofire7Manager6uploadFS0_FTPS_21URLRequestConvertible_4fileCSo5NSURL_CS_7Request</USR>
<Declaration>public func upload(URLRequest: URLRequestConvertible, file: NSURL) -&gt; Request</Declaration>
<Abstract>
<Para>Creates a request for uploading a file to the specified URL request.</Para>
</Abstract>
<Discussion>
<Para>If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>URLRequest</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL request</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>file</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The file to upload</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created upload request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1036">
<Name>upload(_:stream:)</Name>
<USR>s:FC9Alamofire7Manager6uploadFS0_FTPS_21URLRequestConvertible_6streamCSo13NSInputStream_CS_7Request</USR>
<Declaration>public func upload(URLRequest: URLRequestConvertible, stream: NSInputStream) -&gt; Request</Declaration>
<Abstract>
<Para>Creates a request for uploading a stream to the specified URL request.</Para>
</Abstract>
<Discussion>
<Para>If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>URLRequest</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL request</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>stream</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The stream to upload</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created upload request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1104">
<Name>download(_:destination:)</Name>
<USR>s:FC9Alamofire7Manager8downloadFS0_FTPS_21URLRequestConvertible_11destinationFTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request</USR>
<Declaration>public func download(URLRequest: URLRequestConvertible, destination: (NSURL, NSHTTPURLResponse) -&gt; (NSURL)) -&gt; Request</Declaration>
<Abstract>
<Para>Creates a request for downloading from the specified URL request.</Para>
</Abstract>
<Discussion>
<Para>If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>URLRequest</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL request</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>destination</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The closure used to determine the destination of the downloaded file.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created download request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1120">
<Name>download(_:destination:)</Name>
<USR>s:FC9Alamofire7Manager8downloadFS0_FTCSo6NSData11destinationFTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request</USR>
<Declaration>public func download(resumeData: NSData, destination: Request.DownloadFileDestination) -&gt; Request</Declaration>
<Abstract>
<Para>Creates a request for downloading from the resume data produced from a previous request cancellation.</Para>
</Abstract>
<Discussion>
<Para>If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>resumeData</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The resume data. This is an opaque data blob produced by `NSURLSessionDownloadTask` when a task is cancelled. See `NSURLSession -downloadTaskWithResumeData:` for additional information.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>destination</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The closure used to determine the destination of the downloaded file.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created download request.</Para>
</ResultDiscussion>
</Function>
<Other column="22" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1129">
<Name>DownloadFileDestination</Name>
<USR>s:C9Alamofire7Request23DownloadFileDestination</USR>
<Declaration>public typealias DownloadFileDestination = (NSURL, NSHTTPURLResponse) -&gt; (NSURL)</Declaration>
<Abstract>
<Para>A closure executed once a request has successfully completed in order to determine where to move the temporary file written to during the download process. The closure takes two arguments: the temporary file URL and the URL response, and returns a single argument: the file URL where the temporary file should be moved.</Para>
</Abstract>
</Other>
<Function column="23" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1139">
<Name>suggestedDownloadDestination(directory:domain:)</Name>
<USR>s:FC9Alamofire7Request28suggestedDownloadDestinationFMS0_FT9directoryOSC21NSSearchPathDirectory6domainVSC22NSSearchPathDomainMask_FTCSo5NSURLCSo17NSHTTPURLResponse_S3_</USR>
<Declaration>public class func suggestedDownloadDestination(directory: NSSearchPathDirectory = default, domain: NSSearchPathDomainMask = default) -&gt; DownloadFileDestination</Declaration>
<Abstract>
<Para>Creates a download file destination closure which uses the default file manager to move the temporary file to a file URL in the first available directory with the specified search path directory and search path domain mask.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>directory</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The search path directory. `.DocumentDirectory` by default.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>domain</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The search path domain mask. `.UserDomainMask` by default.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>A download file destination closure.</Para>
</ResultDiscussion>
</Function>
<Other column="16" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1197">
<Name>description</Name>
<USR>s:vC9Alamofire7Request11descriptionSS</USR>
<Declaration>public var description: String { get }</Declaration>
<Abstract>
<Para>The textual representation used when written to an `OutputStreamType`, which includes the HTTP method and URL, as well as the response status code if a response has been received.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1273">
<Name>debugDescription</Name>
<USR>s:vC9Alamofire7Request16debugDescriptionSS</USR>
<Declaration>public var debugDescription: String { get }</Declaration>
<Abstract>
<Para>The textual representation used when written to an `OutputStreamType`, in the form of a cURL command.</Para>
</Abstract>
</Other>
<Function column="23" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1290">
<Name>stringResponseSerializer(encoding:)</Name>
<USR>s:FC9Alamofire7Request24stringResponseSerializerFMS0_FT8encodingSu_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__</USR>
<Declaration>public class func stringResponseSerializer(encoding: NSStringEncoding = default) -&gt; Serializer</Declaration>
<Abstract>
<Para>Creates a response serializer that returns a string initialized from the response data with the specified string encoding.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>encoding</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The string encoding. `NSUTF8StringEncoding` by default.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>A string response serializer.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1305">
<Name>responseString(_:)</Name>
<USR>s:FC9Alamofire7Request14responseStringFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqSS_GSqCSo7NSError__T_DS0_</USR>
<Declaration>public func responseString(completionHandler: (NSURLRequest, NSHTTPURLResponse?, String?, NSError?) -&gt; Void) -&gt; Self</Declaration>
<Discussion>
<Para>Adds a handler to be called once the request has finished.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>completionHandler</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>A closure to be executed once the request has finished. The closure takes 4 arguments: the URL request, the URL response, if one was received, the string, if one could be created from the URL response and data, and any error produced while creating the string.</Para>
<Para>returnsThe request.</Para>
</Discussion>
</Parameter>
</Parameters>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1317">
<Name>responseString(encoding:completionHandler:)</Name>
<USR>s:FC9Alamofire7Request14responseStringFDS0_FT8encodingSu17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqSS_GSqCSo7NSError__T__DS0_</USR>
<Declaration>public func responseString(encoding: NSStringEncoding = default, completionHandler: (NSURLRequest, NSHTTPURLResponse?, String?, NSError?) -&gt; Void) -&gt; Self</Declaration>
<Abstract>
<Para>Adds a handler to be called once the request has finished.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>encoding</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The string encoding. `NSUTF8StringEncoding` by default.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>completionHandler</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>A closure to be executed once the request has finished. The closure takes 4 arguments: the URL request, the URL response, if one was received, the string, if one could be created from the URL response and data, and any error produced while creating the string.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1334">
<Name>JSONResponseSerializer(options:)</Name>
<USR>s:FC9Alamofire7Request22JSONResponseSerializerFMS0_FT7optionsVSC20NSJSONReadingOptions_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__</USR>
<Declaration>public class func JSONResponseSerializer(options: NSJSONReadingOptions = default) -&gt; Serializer</Declaration>
<Abstract>
<Para>Creates a response serializer that returns a JSON object constructed from the response data using `NSJSONSerialization` with the specified reading options.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>options</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The JSON serialization reading options. `.AllowFragments` by default.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>A JSON object response serializer.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1354">
<Name>responseJSON(_:)</Name>
<USR>s:FC9Alamofire7Request12responseJSONFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_</USR>
<Declaration>public func responseJSON(completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</Declaration>
<Abstract>
<Para>Adds a handler to be called once the request has finished.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>completionHandler</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>A closure to be executed once the request has finished. The closure takes 4 arguments: the URL request, the URL response, if one was received, the JSON object, if one could be created from the URL response and data, and any error produced while creating the JSON object.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1366">
<Name>responseJSON(options:completionHandler:)</Name>
<USR>s:FC9Alamofire7Request12responseJSONFDS0_FT7optionsVSC20NSJSONReadingOptions17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__DS0_</USR>
<Declaration>public func responseJSON(options: NSJSONReadingOptions = default, completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</Declaration>
<Abstract>
<Para>Adds a handler to be called once the request has finished.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>options</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The JSON serialization reading options. `.AllowFragments` by default.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>completionHandler</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>A closure to be executed once the request has finished. The closure takes 4 arguments: the URL request, the URL response, if one was received, the JSON object, if one could be created from the URL response and data, and any error produced while creating the JSON object.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1383">
<Name>propertyListResponseSerializer(options:)</Name>
<USR>s:FC9Alamofire7Request30propertyListResponseSerializerFMS0_FT7optionsSi_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__</USR>
<Declaration>public class func propertyListResponseSerializer(options: NSPropertyListReadOptions = default) -&gt; Serializer</Declaration>
<Abstract>
<Para>Creates a response serializer that returns an object constructed from the response data using `NSPropertyListSerialization` with the specified reading options.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>options</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The property list reading options. `0` by default.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>A property list object response serializer.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1403">
<Name>responsePropertyList(_:)</Name>
<USR>s:FC9Alamofire7Request20responsePropertyListFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_</USR>
<Declaration>public func responsePropertyList(completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</Declaration>
<Abstract>
<Para>Adds a handler to be called once the request has finished.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>completionHandler</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>A closure to be executed once the request has finished. The closure takes 4 arguments: the URL request, the URL response, if one was received, the property list, if one could be created from the URL response and data, and any error produced while creating the property list.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1415">
<Name>responsePropertyList(options:completionHandler:)</Name>
<USR>s:FC9Alamofire7Request20responsePropertyListFDS0_FT7optionsSi17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__DS0_</USR>
<Declaration>public func responsePropertyList(options: NSPropertyListReadOptions = default, completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</Declaration>
<Abstract>
<Para>Adds a handler to be called once the request has finished.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>options</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The property list reading options. `0` by default.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>completionHandler</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>A closure to be executed once the request has finished. The closure takes 4 arguments: the URL request, the URL response, if one was received, the property list, if one could be created from the URL response and data, and any error produced while creating the property list.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1443">
<Name>request(_:_:parameters:encoding:)</Name>
<USR>s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request</USR>
<Declaration>public func request(method: Method, URLString: URLStringConvertible, parameters: [String : AnyObject]? = default, encoding: ParameterEncoding = default) -&gt; Request</Declaration>
<Abstract>
<Para>Creates a request using the shared manager instance for the specified method, URL string, parameters, and parameter encoding.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>method</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The HTTP method.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>URLString</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL string.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>parameters</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The parameters. `nil` by default.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>encoding</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The parameter encoding. `.URL` by default.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1456">
<Name>request(_:)</Name>
<USR>s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request</USR>
<Declaration>public func request(URLRequest: URLRequestConvertible) -&gt; Request</Declaration>
<Abstract>
<Para>Creates a request using the shared manager instance for the specified URL request.</Para>
</Abstract>
<Discussion>
<Para>If `startRequestsImmediately` is `true`, the request will have `resume()` called before being returned.</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>URLRequest</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL request</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1473">
<Name>upload(_:_:_:)</Name>
<USR>s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request</USR>
<Declaration>public func upload(method: Method, URLString: URLStringConvertible, file: NSURL) -&gt; Request</Declaration>
<Abstract>
<Para>Creates an upload request using the shared manager instance for the specified method, URL string, and file.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>method</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The HTTP method.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>URLString</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL string.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>file</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The file to upload.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created upload request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1485">
<Name>upload(_:_:)</Name>
<USR>s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request</USR>
<Declaration>public func upload(URLRequest: URLRequestConvertible, file: NSURL) -&gt; Request</Declaration>
<Abstract>
<Para>Creates an upload request using the shared manager instance for the specified URL request and file.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>URLRequest</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL request.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>file</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The file to upload.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created upload request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1500">
<Name>upload(_:_:_:)</Name>
<USR>s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request</USR>
<Declaration>public func upload(method: Method, URLString: URLStringConvertible, data: NSData) -&gt; Request</Declaration>
<Abstract>
<Para>Creates an upload request using the shared manager instance for the specified method, URL string, and data.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>method</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The HTTP method.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>URLString</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL string.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>data</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The data to upload.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created upload request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1512">
<Name>upload(_:_:)</Name>
<USR>s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request</USR>
<Declaration>public func upload(URLRequest: URLRequestConvertible, data: NSData) -&gt; Request</Declaration>
<Abstract>
<Para>Creates an upload request using the shared manager instance for the specified URL request and data.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>URLRequest</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL request.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>data</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The data to upload.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created upload request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1527">
<Name>upload(_:_:_:)</Name>
<USR>s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request</USR>
<Declaration>public func upload(method: Method, URLString: URLStringConvertible, stream: NSInputStream) -&gt; Request</Declaration>
<Abstract>
<Para>Creates an upload request using the shared manager instance for the specified method, URL string, and stream.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>method</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The HTTP method.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>URLString</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL string.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>stream</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The stream to upload.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created upload request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1539">
<Name>upload(_:_:)</Name>
<USR>s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request</USR>
<Declaration>public func upload(URLRequest: URLRequestConvertible, stream: NSInputStream) -&gt; Request</Declaration>
<Abstract>
<Para>Creates an upload request using the shared manager instance for the specified URL request and stream.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>URLRequest</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL request.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>stream</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The stream to upload.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created upload request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1556">
<Name>download(_:_:_:)</Name>
<USR>s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request</USR>
<Declaration>public func download(method: Method, URLString: URLStringConvertible, destination: Request.DownloadFileDestination) -&gt; Request</Declaration>
<Abstract>
<Para>Creates a download request using the shared manager instance for the specified method and URL string.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>method</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The HTTP method.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>URLString</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL string.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>destination</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The closure used to determine the destination of the downloaded file.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created download request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1568">
<Name>download(_:_:)</Name>
<USR>s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request</USR>
<Declaration>public func download(URLRequest: URLRequestConvertible, destination: Request.DownloadFileDestination) -&gt; Request</Declaration>
<Abstract>
<Para>Creates a download request using the shared manager instance for the specified URL request.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>URLRequest</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The URL request.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>destination</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The closure used to determine the destination of the downloaded file.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created download request.</Para>
</ResultDiscussion>
</Function>
<Function column="13" file="/Users/jp/Projects/Alamofire/Source/Alamofire.swift" line="1582">
<Name>download(resumeData:_:)</Name>
<USR>s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request</USR>
<Declaration>public func download(resumeData data: NSData, destination: Request.DownloadFileDestination) -&gt; Request</Declaration>
<Abstract>
<Para>Creates a request using the shared manager instance for downloading from the resume data produced from a previous request cancellation.</Para>
</Abstract>
<Parameters>
<Parameter>
<Name>resumeData</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The resume data. This is an opaque data blob produced by `NSURLSessionDownloadTask` when a task is cancelled. See `NSURLSession -downloadTaskWithResumeData:` for additional information.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>destination</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The closure used to determine the destination of the downloaded file.</Para>
</Discussion>
</Parameter>
</Parameters>
<ResultDiscussion>
<Para>The created download request.</Para>
</ResultDiscussion>
</Function>
</jazzy>
Raw
Cent.xml
<jazzy>
<Function column="12" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="40">
<Name>init(array:)</Name>
<USR>s:FC6Dollar6DollarcFMS0_FT5arrayGSaPSs9AnyObject___S0_</USR>
<Declaration>public init(array: [AnyObject])</Declaration>
<Abstract>
<Para>Initializer of the wrapper object for chaining.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="52">
<Name>first()</Name>
<USR>s:FC6Dollar6Dollar5firstFS0_FT_S0_</USR>
<Declaration>public func first() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the first object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return First element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="488">
<Name>first(_:)</Name>
<USR>s:FC6Dollar6Dollar5firstFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func first&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the first element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return First element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="61">
<Name>second()</Name>
<USR>s:FC6Dollar6Dollar6secondFS0_FT_S0_</USR>
<Declaration>public func second() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the second object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Second element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="500">
<Name>second(_:)</Name>
<USR>s:FC6Dollar6Dollar6secondFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func second&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the second element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Second element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="70">
<Name>third()</Name>
<USR>s:FC6Dollar6Dollar5thirdFS0_FT_S0_</USR>
<Declaration>public func third() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the third object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Third element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="512">
<Name>third(_:)</Name>
<USR>s:FC6Dollar6Dollar5thirdFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func third&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the third element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Third element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="79">
<Name>fourth()</Name>
<USR>s:FC6Dollar6Dollar6fourthFS0_FT_S0_</USR>
<Declaration>public func fourth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the fourth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Fourth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="524">
<Name>fourth(_:)</Name>
<USR>s:FC6Dollar6Dollar6fourthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func fourth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the fourth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Fourth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="88">
<Name>fifth()</Name>
<USR>s:FC6Dollar6Dollar5fifthFS0_FT_S0_</USR>
<Declaration>public func fifth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the fifth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Fifth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="536">
<Name>fifth(_:)</Name>
<USR>s:FC6Dollar6Dollar5fifthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func fifth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the fifth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Fifth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="97">
<Name>sixth()</Name>
<USR>s:FC6Dollar6Dollar5sixthFS0_FT_S0_</USR>
<Declaration>public func sixth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the sixth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Sixth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="548">
<Name>sixth(_:)</Name>
<USR>s:FC6Dollar6Dollar5sixthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func sixth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the sixth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Sixth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="106">
<Name>seventh()</Name>
<USR>s:FC6Dollar6Dollar7seventhFS0_FT_S0_</USR>
<Declaration>public func seventh() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the seventh object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Seventh element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="560">
<Name>seventh(_:)</Name>
<USR>s:FC6Dollar6Dollar7seventhFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func seventh&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the seventh element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Seventh element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="115">
<Name>eighth()</Name>
<USR>s:FC6Dollar6Dollar6eighthFS0_FT_S0_</USR>
<Declaration>public func eighth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the eighth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Eighth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="572">
<Name>eighth(_:)</Name>
<USR>s:FC6Dollar6Dollar6eighthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func eighth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the eighth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Eighth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="124">
<Name>ninth()</Name>
<USR>s:FC6Dollar6Dollar5ninthFS0_FT_S0_</USR>
<Declaration>public func ninth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the ninth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Ninth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="584">
<Name>ninth(_:)</Name>
<USR>s:FC6Dollar6Dollar5ninthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func ninth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the ninth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Ninth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="133">
<Name>tenth()</Name>
<USR>s:FC6Dollar6Dollar5tenthFS0_FT_S0_</USR>
<Declaration>public func tenth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the tenth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Tenth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="596">
<Name>tenth(_:)</Name>
<USR>s:FC6Dollar6Dollar5tenthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func tenth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the tenth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Tenth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="143">
<Name>flatten()</Name>
<USR>s:FC6Dollar6Dollar7flattenFS0_FT_S0_</USR>
<Declaration>public func flatten() -&gt; Dollar</Declaration>
<Abstract>
<Para>Another comment Flattens nested array.</Para>
</Abstract>
<Discussion>
<Para>:return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="608">
<Name>flatten(_:)</Name>
<USR>s:FC6Dollar6Dollar7flattenFMS0_FGSaPSs9AnyObject__GSaPS1___</USR>
<Declaration>public class func flatten(array: [AnyObject]) -&gt; [AnyObject]</Declaration>
<Abstract>
<Para>Flattens a nested array of any depth.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to flatten. :return Flattened array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="152">
<Name>initial()</Name>
<USR>s:FC6Dollar6Dollar7initialFS0_FT_S0_</USR>
<Declaration>public func initial() -&gt; Dollar</Declaration>
<Abstract>
<Para>Keeps all the elements except last one.</Para>
</Abstract>
<Discussion>
<Para>:return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="160">
<Name>initial(_:)</Name>
<USR>s:FC6Dollar6Dollar7initialFS0_FSiS0_</USR>
<Declaration>public func initial(numElements: Int) -&gt; Dollar</Declaration>
<Abstract>
<Para>Keeps all the elements except last n elements.</Para>
</Abstract>
<Discussion>
<Para>:param numElements Number of items to remove from the end of the array. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="688">
<Name>initial(_:numElements:)</Name>
<USR>s:FC6Dollar6Dollar7initialFMS0_U__FTGSaQ__11numElementsSi_GSaQ__</USR>
<Declaration>public class func initial&lt;T&gt;(array: [T], numElements: Int = default) -&gt; [T]</Declaration>
<Abstract>
<Para>Gets all but the last element or last n elements of an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param numElements The number of elements to ignore in the end. :return Array of initial values.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="170">
<Name>map(_:)</Name>
<USR>s:FC6Dollar6Dollar3mapFS0_FFPSs9AnyObject_PS1__S0_</USR>
<Declaration>public func map(function: (AnyObject) -&gt; AnyObject) -&gt; Dollar</Declaration>
<Abstract>
<Para>Maps elements to new elements.</Para>
</Abstract>
<Discussion>
<Para>:param function Function to map. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="184">
<Name>map(_:)</Name>
<USR>s:FC6Dollar6Dollar3mapFS0_FFTSiPSs9AnyObject__PS1__S0_</USR>
<Declaration>public func map(function: (Int, AnyObject) -&gt; AnyObject) -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the first object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="198">
<Name>each(_:)</Name>
<USR>s:FC6Dollar6Dollar4eachFS0_FFPSs9AnyObject_T_S0_</USR>
<Declaration>public func each(function: (AnyObject) -&gt; ()) -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the first object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="211">
<Name>each(_:)</Name>
<USR>s:FC6Dollar6Dollar4eachFS0_FFTSiPSs9AnyObject__T_S0_</USR>
<Declaration>public func each(function: (Int, AnyObject) -&gt; ()) -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the first object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="224">
<Name>filter(_:)</Name>
<USR>s:FC6Dollar6Dollar6filterFS0_FFPSs9AnyObject_SbS0_</USR>
<Declaration>public func filter(function: (AnyObject) -&gt; Bool) -&gt; Dollar</Declaration>
<Abstract>
<Para>Filter elements based on the function passed.</Para>
</Abstract>
<Discussion>
<Para>:param function Function to tell whether to keep an element or remove. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="234">
<Name>all(_:)</Name>
<USR>s:FC6Dollar6Dollar3allFS0_FFPSs9AnyObject_SbS0_</USR>
<Declaration>public func all(function: (AnyObject) -&gt; Bool) -&gt; Dollar</Declaration>
<Abstract>
<Para>Returns if all elements in array are true based on the passed function.</Para>
</Abstract>
<Discussion>
<Para>:param function Function to tell whether element value is true or false. :return Whether all elements are true according to func function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="426">
<Name>every(_:iterator:)</Name>
<USR>s:FC6Dollar6Dollar5everyFMS0_U__FTGSaQ__8iteratorFQ_Sb_Sb</USR>
<Declaration>public class func every&lt;T&gt;(array: [T], iterator: (T) -&gt; Bool) -&gt; Bool</Declaration>
<Abstract>
<Para>Checks if the given callback returns true value for all items in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to check. :param iterator Check whether element value is true or false. :return First element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="244">
<Name>any(_:)</Name>
<USR>s:FC6Dollar6Dollar3anyFS0_FFPSs9AnyObject_SbS0_</USR>
<Declaration>public func any(function: (AnyObject) -&gt; Bool) -&gt; Dollar</Declaration>
<Abstract>
<Para>Returns if any element in array is true based on the passed function.</Para>
</Abstract>
<Discussion>
<Para>:param function Function to tell whether element value is true or false. :return Whether any one element is true according to func function in the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="260">
<Name>slice(_:end:)</Name>
<USR>s:FC6Dollar6Dollar5sliceFS0_FTSi3endSi_S0_</USR>
<Declaration>public func slice(start: Int, end: Int = default) -&gt; Dollar</Declaration>
<Abstract>
<Para>Slice the array into smaller size based on start and end value.</Para>
</Abstract>
<Discussion>
<Para>:param start Start index to start slicing from. :param end End index to stop slicing to and not including element at that index. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1102">
<Name>slice(_:start:end:)</Name>
<USR>s:FC6Dollar6Dollar5sliceFMS0_U__FTGSaQ__5startSi3endSi_GSaQ__</USR>
<Declaration>public class func slice&lt;T&gt;(array: [T], start: Int, end: Int = default) -&gt; [T]</Declaration>
<Abstract>
<Para>Slices the array based on the start and end position. If an end position is not specified it will slice till the end of the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to slice. :param start Start index. :param end End index. :return First element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="269">
<Name>value()</Name>
<USR>s:FC6Dollar6Dollar5valueFS0_FT_GSqPSs9AnyObject__</USR>
<Declaration>public func value() -&gt; AnyObject?</Declaration>
<Abstract>
<Para>Get the final result from the wrapper object to terminated the chain.</Para>
</Abstract>
<Discussion>
<Para>:return Final resulting array from applying all functions on it.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="295">
<Name>after(_:function:)</Name>
<USR>s:FC6Dollar6Dollar5afterFMS0_U___FTSi8functionFtGSaQ___Q0__FtGSaQ___GSqQ0__</USR>
<Declaration>public class func after&lt;T, E&gt;(n: Int, function: (T...) -&gt; E) -&gt; ((T...) -&gt; E?)</Declaration>
<Discussion>
<Para>___ ___ _______ ___ ________ _______ ________</Para>
<Para>|\ \|\ \|\ ___ \ |\ \ |\ __ \|\ ___ \ |\ __ \ \ \ \\\ \ \ __/|\ \ \ \ \ \|\ \ \ __/|\ \ \|\ \</Para>
<Para>\ \ __ \ \ \_|/_\ \ \ \ \ ____\ \ \_|/_\ \ _ _\\ \ \ \ \ \ \_|\ \ \ \____\ \ \___|\ \ \_|\ \ \ \\ \|\ \__\ \__\ \_______\ \_______\ \__\ \ \_______\ \__\\ _\\|__|\|__|\|_______|\|_______|\|__| \|_______|\|__|\|__|</Para>
<Para>Creates a function that executes passed function only after being called n times.</Para>
<Para>:param n Number of times after which to call function. :param function Function to be called that takes params. :return Function that can be called n times after which the callback function is called.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="312">
<Name>after(_:function:)</Name>
<USR>s:FC6Dollar6Dollar5afterFMS0_U__FTSi8functionFT_Q__FT_GSqQ__</USR>
<Declaration>public class func after&lt;T&gt;(n: Int, function: () -&gt; T) -&gt; (() -&gt; T?)</Declaration>
<Abstract>
<Para>Creates a function that executes passed function only after being called n times.</Para>
</Abstract>
<Discussion>
<Para>:param n Number of times after which to call function. :param function Function to be called that does not take any params. :return Function that can be called n times after which the callback function is called.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="325">
<Name>at(_:indexes:)</Name>
<USR>s:FC6Dollar6Dollar2atFMS0_U__FtGSaQ__7indexesGSaSi__GSaQ__</USR>
<Declaration>public class func at&lt;T&gt;(array: [T], indexes: Int...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of elements from the specified indexes, or keys, of the collection. Indexes may be specified as individual arguments or as arrays of indexes.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from :param indexes Get elements from these indexes :return New array with elements from the indexes specified.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="335">
<Name>at(_:indexes:)</Name>
<USR>s:FC6Dollar6Dollar2atFMS0_U__FTGSaQ__7indexesGSaSi__GSaQ__</USR>
<Declaration>public class func at&lt;T&gt;(array: [T], indexes: [Int]) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of elements from the specified indexes, or keys, of the collection. Indexes may be specified as individual arguments or as arrays of indexes.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from :param indexes Get elements from these indexes :return New array with elements from the indexes specified.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="348">
<Name>bind(_:_:)</Name>
<USR>s:FC6Dollar6Dollar4bindFMS0_U___FtFtGSaQ___Q0_GSaQ___FT_Q0_</USR>
<Declaration>public class func bind&lt;T, E&gt;(function: (T...) -&gt; E, _ parameters: T...) -&gt; (() -&gt; E)</Declaration>
<Abstract>
<Para>Creates a function that, when called, invokes func with the binding of arguments provided.</Para>
</Abstract>
<Discussion>
<Para>:param function Function to be bound. :param parameters Parameters to be passed into the function when being invoked. :return A new function that when called will invoked the passed function with the parameters specified.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="360">
<Name>compact(_:)</Name>
<USR>s:FC6Dollar6Dollar7compactFMS0_U__FGSaGSqQ___GSaQ__</USR>
<Declaration>public class func compact&lt;T&gt;(array: [T?]) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array with all nil values removed.</Para>
</Abstract>
<Discussion>
<Para>:param array Array to be compacted. :return A new array that doesnt have any nil values.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="375">
<Name>contains(_:value:)</Name>
<USR>s:FC6Dollar6Dollar8containsFMS0_USs9Equatable__FTGSaQ__5valueQ__Sb</USR>
<Declaration>public class func contains&lt;T : Equatable&gt;(array: [T], value: T) -&gt; Bool</Declaration>
<Abstract>
<Para>Checks if a given value is present in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to check against. :param value The value to check. :return Whether value is in the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="383">
<Name>copy(_:)</Name>
<USR>s:FC6Dollar6Dollar4copyFMS0_U__FGSaQ__GSaQ__</USR>
<Declaration>public class func copy&lt;T&gt;(array: [T]) -&gt; [T]</Declaration>
<Abstract>
<Para>Create a copy of an array</Para>
</Abstract>
<Discussion>
<Para>:param array The array to copy :return New copy of array</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="395">
<Name>difference(_:)</Name>
<USR>s:FC6Dollar6Dollar10differenceFMS0_USs8Hashable__FtGSaGSaQ____GSaQ__</USR>
<Declaration>public class func difference&lt;T : Hashable&gt;(arrays: [T]...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array excluding all values of the provided arrays.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to difference between. :return The difference between the first array and all the remaining arrays from the arrays params.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1078">
<Name>rest(_:numElements:)</Name>
<USR>s:FC6Dollar6Dollar4restFMS0_U__FTGSaQ__11numElementsSi_GSaQ__</USR>
<Declaration>public class func rest&lt;T&gt;(array: [T], numElements: Int = default) -&gt; [T]</Declaration>
<Abstract>
<Para>The opposite of initial this method gets all but the first element or first n elements of an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param numElements The number of elements to exclude from the beginning. :return The rest of the elements.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="441">
<Name>find(_:iterator:)</Name>
<USR>s:FC6Dollar6Dollar4findFMS0_USs9Equatable__FTGSaQ__8iteratorFQ_Sb_GSqQ__</USR>
<Declaration>public class func find&lt;T : Equatable&gt;(array: [T], iterator: (T) -&gt; Bool) -&gt; T?</Declaration>
<Abstract>
<Para>Iterates over elements of an array and returning the first element that the callback returns true for.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to search for the element in. :param iterator The iterator function to tell whether element is found. :return Optional containing either found element or nil.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="457">
<Name>findIndex(_:iterator:)</Name>
<USR>s:FC6Dollar6Dollar9findIndexFMS0_U__FTGSaQ__8iteratorFQ_Sb_GSqSi_</USR>
<Declaration>public class func findIndex&lt;T&gt;(array: [T], iterator: (T) -&gt; Bool) -&gt; Int?</Declaration>
<Abstract>
<Para>This method is like find except that it returns the index of the first element that passes the callback check.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to search for the element in. :param iterator Function used to figure out whether element is the same. :return First element's index from the array found using the iterator.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="472">
<Name>findLastIndex(_:iterator:)</Name>
<USR>s:FC6Dollar6Dollar13findLastIndexFMS0_U__FTGSaQ__8iteratorFQ_Sb_GSqSi_</USR>
<Declaration>public class func findLastIndex&lt;T&gt;(array: [T], iterator: (T) -&gt; Bool) -&gt; Int?</Declaration>
<Abstract>
<Para>This method is like findIndex except that it iterates over elements of the array from right to left.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to search for the element in. :param iterator Function used to figure out whether element is the same. :return Last element's index from the array found using the iterator.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="624">
<Name>shuffle(_:)</Name>
<USR>s:FC6Dollar6Dollar7shuffleFMS0_U__FGSaQ__GSaQ__</USR>
<Declaration>public class func shuffle&lt;T&gt;(array: [T]) -&gt; [T]</Declaration>
<Abstract>
<Para>Randomly shuffles the elements of an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to shuffle. :return Shuffled array</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="642">
<Name>frequencies(_:)</Name>
<USR>s:FC6Dollar6Dollar11frequenciesFMS0_USs8Hashable__FGSaQ__GVSs10DictionaryQ_Si_</USR>
<Declaration>public class func frequencies&lt;T&gt;(array: [T]) -&gt; [T : Int]</Declaration>
<Abstract>
<Para>This method returns a dictionary of values in an array mapping to the total number of occurrences in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return Dictionary that contains the key generated from the element passed in the function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="653">
<Name>frequencies(_:function:)</Name>
<USR>s:FC6Dollar6Dollar11frequenciesFMS0_U_Ss8Hashable__FTGSaQ__8functionFQ_Q0__GVSs10DictionaryQ0_Si_</USR>
<Declaration>public class func frequencies&lt;T, U : Equatable&gt;(array: [T], function: (T) -&gt; U) -&gt; [U : Int]</Declaration>
<Abstract>
<Para>This method returns a dictionary of values in an array mapping to the total number of occurrences in the array. If passed a function it returns a frequency table of the results of the given function on the arrays elements.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param function The function to get value of the key for each element to group by. :return Dictionary that contains the key generated from the element passed in the function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="670">
<Name>id(_:)</Name>
<USR>s:FC6Dollar6Dollar2idFMS0_U__FQ_Q_</USR>
<Declaration>public class func id&lt;T&gt;(arg: T) -&gt; T</Declaration>
<Abstract>
<Para>The identity function. Returns the argument it is given.</Para>
</Abstract>
<Discussion>
<Para>:param arg Value to return :return Argument that was passed</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="679">
<Name>indexOf(_:value:)</Name>
<USR>s:FC6Dollar6Dollar7indexOfFMS0_USs9Equatable__FTGSaQ__5valueQ__GSqSi_</USR>
<Declaration>public class func indexOf&lt;T : Equatable&gt;(array: [T], value: T) -&gt; Int?</Declaration>
<Abstract>
<Para>Gets the index at which the first occurrence of value is found.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param value Value whose index needs to be found. :return Index of the element otherwise returns nil if not found.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="702">
<Name>intersection(_:)</Name>
<USR>s:FC6Dollar6Dollar12intersectionFMS0_USs8Hashable__FtGSaGSaQ____GSaQ__</USR>
<Declaration>public class func intersection&lt;T : Hashable&gt;(arrays: [T]...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of unique values present in all provided arrays.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to perform an intersection on. :return Intersection of all arrays passed.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="728">
<Name>join(_:separator:)</Name>
<USR>s:FC6Dollar6Dollar4joinFMS0_USs24ExtensibleCollectionType_USs13GeneratorType__Ss16ForwardIndexType_Ss18_SignedIntegerType_Ss33_BuiltinIntegerLiteralConvertible____FTGSaQ__9separatorQ__Q_</USR>
<Declaration>public class func join&lt;T : ExtensibleCollectionType&gt;(array: [T], separator: T) -&gt; T</Declaration>
<Abstract>
<Para>Joins the elements in the array to create a concatenated element of the same type.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to join the elements of. :param separator The separator to join the elements with. :return Joined element from the array of elements.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="736">
<Name>keys(_:)</Name>
<USR>s:FC6Dollar6Dollar4keysFMS0_USs8Hashable___FGVSs10DictionaryQ_Q0__GSaQ__</USR>
<Declaration>public class func keys&lt;T, U&gt;(dictionary: [T : U]) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of keys given a dictionary.</Para>
</Abstract>
<Discussion>
<Para>:param dictionary The dictionary to source from. :return Array of keys from dictionary.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="748">
<Name>last(_:)</Name>
<USR>s:FC6Dollar6Dollar4lastFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func last&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the last element from the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return Last element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="761">
<Name>lastIndexOf(_:value:)</Name>
<USR>s:FC6Dollar6Dollar11lastIndexOfFMS0_USs9Equatable__FTGSaQ__5valueQ__GSqSi_</USR>
<Declaration>public class func lastIndexOf&lt;T : Equatable&gt;(array: [T], value: T) -&gt; Int?</Declaration>
<Abstract>
<Para>Gets the index at which the last occurrence of value is found.</Para>
</Abstract>
<Discussion>
<Para>param: array:: The array to source from. :param value The value whose last index needs to be found. :return Last index of element if found otherwise returns nil.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="770">
<Name>map(_:transform:)</Name>
<USR>s:FC6Dollar6Dollar3mapFMS0_U___FTGSaQ__9transformFQ_Q0__GSaQ0__</USR>
<Declaration>public class func map&lt;T, E&gt;(array: [T], transform: (T) -&gt; E) -&gt; [E]</Declaration>
<Abstract>
<Para>Maps each element to new value based on the map function passed</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param transform The mapping function :return Array of elements mapped using the map function</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="778">
<Name>max(_:)</Name>
<USR>s:FC6Dollar6Dollar3maxFMS0_USs10Comparable__FGSaQ__GSqQ__</USR>
<Declaration>public class func max&lt;T : Comparable&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Retrieves the maximum value in an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return Maximum element in array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="792">
<Name>memoize(_:)</Name>
<USR>s:FC6Dollar6Dollar7memoizeFMS0_USs8Hashable___FFTFQ_Q0_Q__Q0_FQ_Q0_</USR>
<Declaration>public class func memoize&lt;T : Hashable, U&gt;(function: ((T -&gt; U), T) -&gt; U) -&gt; (T -&gt; U)</Declaration>
<Abstract>
<Para>Get memoized function to improve performance</Para>
</Abstract>
<Discussion>
<Para>:param function The function to memoize. :return Memoized function</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="810">
<Name>merge(dictionaries:)</Name>
<USR>s:FC6Dollar6Dollar5mergeFMS0_USs8Hashable___Ft12dictionariesGSaGVSs10DictionaryQ_Q0____GS2_Q_Q0__</USR>
<Declaration>public class func merge&lt;T, U&gt;(#dictionaries: [T : U]...) -&gt; [T : U]</Declaration>
<Abstract>
<Para>Merge dictionaries together, later dictionaries overiding earlier values of keys.</Para>
</Abstract>
<Discussion>
<Para>:param dictionaries The dictionaries to source from. :return Merged dictionary with all of its keys and values.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="824">
<Name>merge(arrays:)</Name>
<USR>s:FC6Dollar6Dollar5mergeFMS0_U__Ft6arraysGSaGSaQ____GSaQ__</USR>
<Declaration>public class func merge&lt;T&gt;(#arrays: [T]...) -&gt; [T]</Declaration>
<Abstract>
<Para>Merge arrays together in the supplied order.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to source from. :return Array with all values merged, including duplicates.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="836">
<Name>min(_:)</Name>
<USR>s:FC6Dollar6Dollar3minFMS0_USs10Comparable__FGSaQ__GSqQ__</USR>
<Declaration>public class func min&lt;T : Comparable&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Retrieves the minimum value in an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return Minimum value from array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="849">
<Name>noop()</Name>
<USR>s:FC6Dollar6Dollar4noopFMS0_FT_GSqPSs9AnyObject__</USR>
<Declaration>public class func noop() -&gt; AnyObject?</Declaration>
<Abstract>
<Para>A no-operation function.</Para>
</Abstract>
<Discussion>
<Para>:return nil.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="858">
<Name>omit(_:keys:)</Name>
<USR>s:FC6Dollar6Dollar4omitFMS0_USs8Hashable___FtGVSs10DictionaryQ_Q0__4keysGSaQ___GS2_Q_Q0__</USR>
<Declaration>public class func omit&lt;T, U&gt;(dictionary: [T : U], keys: T...) -&gt; [T : U]</Declaration>
<Abstract>
<Para>Creates a shallow clone of a dictionary excluding the specified keys.</Para>
</Abstract>
<Discussion>
<Para>:param dictionary The dictionary to source from. :param keys The keys to omit from returning dictionary. :return Dictionary with the keys specified omitted.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="873">
<Name>partial(_:_:)</Name>
<USR>s:FC6Dollar6Dollar7partialFMS0_U___FtFtGSaQ___Q0_GSaQ___FtGSaQ___Q0_</USR>
<Declaration>public class func partial&lt;T, E&gt;(function: (T...) -&gt; E, _ parameters: T...) -&gt; ((T...) -&gt; E)</Declaration>
<Abstract>
<Para>Get the first object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return First element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="888">
<Name>partition(_:n:step:)</Name>
<USR>s:FC6Dollar6Dollar9partitionFMS0_U__FTGSaQ__1nSi4stepGSqSi__GSaGSaQ___</USR>
<Declaration>public class func partition&lt;T&gt;(array: [T], n: Int, step: Int? = default) -&gt; [[T]]</Declaration>
<Abstract>
<Para>Produces an array of arrays, each containing n elements, each offset by step. If the final partition is not n elements long it is dropped.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to partition. :param n The number of elements in each partition. :param step The number of elements to progress between each partition. Set to n if not supplied. :return Array partitioned into n element arrays, starting step elements apart.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1041">
<Name>range(_:endVal:incrementBy:)</Name>
<USR>s:FC6Dollar6Dollar5rangeFMS0_USs10Strideable_USs16SignedNumberType_Ss33_BuiltinIntegerLiteralConvertible__FTQ_6endValQ_11incrementByQQ_6Stride_GSaQ__</USR>
<Declaration>public class func range&lt;T : Strideable&gt;(startVal: T, endVal: T, incrementBy: T.Stride) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of numbers (positive and/or negative) progressing from start up to but not including end.</Para>
</Abstract>
<Discussion>
<Para>:param startVal Start value of range. :param endVal End value of range. :param incrementBy Increment sequence by. :return Array of elements based on the sequence.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="910">
<Name>partition(_:n:step:pad:)</Name>
<USR>s:FC6Dollar6Dollar9partitionFMS0_U__FTGSaQ__1nSi4stepGSqSi_3padGSqGSaQ____GSaGSaQ___</USR>
<Declaration>public class func partition&lt;T&gt;(array: [T], n: Int, step: Int? = default, pad: [T]?) -&gt; [[T]]</Declaration>
<Abstract>
<Para>Produces an array of arrays, each containing n elements, each offset by step.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to partition. :param n The number of elements in each partition. :param step The number of elements to progress between each partition. Set to n if not supplied. :param pad An array of elements to pad the last partition if it is not long enough to</Para>
<Para>contain n elements. If nil is passed or there are not enough pad elements the last partition may less than n elements long.</Para>
<Para>:return Array partitioned into n element arrays, starting step elements apart.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="937">
<Name>partitionAll(_:n:step:)</Name>
<USR>s:FC6Dollar6Dollar12partitionAllFMS0_U__FTGSaQ__1nSi4stepGSqSi__GSaGSaQ___</USR>
<Declaration>public class func partitionAll&lt;T&gt;(array: [T], n: Int, step: Int? = default) -&gt; [[T]]</Declaration>
<Abstract>
<Para>Produces an array of arrays, each containing n elements, each offset by step.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to partition. :param n The number of elements in each partition. :param step The number of elements to progress between each partition. Set to n if not supplied. :return Array partitioned into n element arrays, starting step elements apart.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="956">
<Name>partitionBy(_:function:)</Name>
<USR>s:FC6Dollar6Dollar11partitionByFMS0_U_Ss9Equatable__FTGSaQ__8functionFQ_Q0__GSaGSaQ___</USR>
<Declaration>public class func partitionBy&lt;T, U : Equatable&gt;(array: [T], function: (T) -&gt; U) -&gt; [[T]]</Declaration>
<Abstract>
<Para>Applies function to each element in array, splitting it each time function returns a new value.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to partition. :param function Function which takes an element and produces an equatable result. :return Array partitioned in order, splitting via results of function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="978">
<Name>pick(_:keys:)</Name>
<USR>s:FC6Dollar6Dollar4pickFMS0_USs8Hashable___FtGVSs10DictionaryQ_Q0__4keysGSaQ___GS2_Q_Q0__</USR>
<Declaration>public class func pick&lt;T, U&gt;(dictionary: [T : U], keys: T...) -&gt; [T : U]</Declaration>
<Abstract>
<Para>Creates a shallow clone of a dictionary composed of the specified keys.</Para>
</Abstract>
<Discussion>
<Para>:param dictionary The dictionary to source from. :param keys The keys to pick values from. :return Dictionary with the key and values picked from the keys specified.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="991">
<Name>pluck(_:value:)</Name>
<USR>s:FC6Dollar6Dollar5pluckFMS0_USs8Hashable___FTGSaGVSs10DictionaryQ_Q0___5valueQ__GSaQ0__</USR>
<Declaration>public class func pluck&lt;T, E&gt;(array: [[T : E]], value: T) -&gt; [E]</Declaration>
<Abstract>
<Para>Retrieves the value of a specified property from all elements in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param value The property on object to pull out value from. :return Array of values from array of objects with property of value.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1005">
<Name>pull(_:values:)</Name>
<USR>s:FC6Dollar6Dollar4pullFMS0_USs9Equatable__FtGSaQ__6valuesGSaQ___GSaQ__</USR>
<Declaration>public class func pull&lt;T : Equatable&gt;(array: [T], values: T...) -&gt; [T]</Declaration>
<Abstract>
<Para>Removes all provided values from the given array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return Array with values pulled out.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1014">
<Name>pull(_:values:)</Name>
<USR>s:FC6Dollar6Dollar4pullFMS0_USs9Equatable__FTGSaQ__6valuesGSaQ___GSaQ__</USR>
<Declaration>public class func pull&lt;T : Equatable&gt;(array: [T], values: [T]) -&gt; [T]</Declaration>
<Abstract>
<Para>Removes all provided values from the given array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param values The values to remove. :return Array with values pulled out.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1022">
<Name>range(_:)</Name>
<USR>s:FC6Dollar6Dollar5rangeFMS0_USs25IntegerLiteralConvertibleSs10Strideable_USs33_BuiltinIntegerLiteralConvertible_Ss16SignedNumberType_S3___FQ_GSaQ__</USR>
<Declaration>public class func range&lt;T : Strideable where T : IntegerLiteralConvertible&gt;(endVal: T) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of numbers (positive and/or negative) progressing from start up to but not including end.</Para>
</Abstract>
<Discussion>
<Para>:param endVal End value of range. :return Array of elements based on the sequence starting from 0 to endVal and incremented by 1.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1031">
<Name>range(_:endVal:)</Name>
<USR>s:FC6Dollar6Dollar5rangeFMS0_USs10Strideable_USs16SignedNumberType_Ss33_BuiltinIntegerLiteralConvertible__FTQ_6endValQ__GSaQ__</USR>
<Declaration>public class func range&lt;T : Strideable where T.Stride : IntegerLiteralConvertible&gt;(startVal: T, endVal: T) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of numbers (positive and/or negative) progressing from start up to but not including end.</Para>
</Abstract>
<Discussion>
<Para>:param startVal Start value of range :param endVal End value of range :return Array of elements based on the sequence that is incremented by 1</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1060">
<Name>sequence(_:)</Name>
<USR>s:FC6Dollar6Dollar8sequenceFMS0_USs12SequenceType_USs13GeneratorType___FQ_GSaQQQ_9Generator7Element_</USR>
<Declaration>public class func sequence&lt;S : SequenceType&gt;(seq: S) -&gt; [S.Generator.Element]</Declaration>
<Abstract>
<Para>Creates an array of an arbitrary sequence. Especially useful with builtin ranges.</Para>
</Abstract>
<Discussion>
<Para>:param seq The sequence to generate from. :return Array of elements generated from the sequence.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1052">
<Name>reduce(_:initial:combine:)</Name>
<USR>s:FC6Dollar6Dollar6reduceFMS0_U___FTGSaQ0__7initialQ_7combineFTQ_Q0__Q__Q_</USR>
<Declaration>public class func reduce&lt;U, T&gt;(array: [T], initial: U, combine: (U, T) -&gt; U) -&gt; U</Declaration>
<Abstract>
<Para>Reduce function that will resolve to one value after performing combine function on all elements</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param initial Initial value to seed the reduce function with :param combine Function that will combine the passed value with element in the array :return The result of reducing all of the elements in the array into one value</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1069">
<Name>remove(_:iterator:)</Name>
<USR>s:FC6Dollar6Dollar6removeFMS0_U__FTGSaQ__8iteratorFQ_Sb_GSaQ__</USR>
<Declaration>public class func remove&lt;T&gt;(array: [T], iterator: (T) -&gt; Bool) -&gt; [T]</Declaration>
<Abstract>
<Para>Removes all elements from an array that the callback returns true.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :param iterator Remove elements for which iterator returns true. :return Array with elements filtered out.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1092">
<Name>sample(_:)</Name>
<USR>s:FC6Dollar6Dollar6sampleFMS0_U__FGSaQ__Q_</USR>
<Declaration>public class func sample&lt;T&gt;(array: [T]) -&gt; T</Declaration>
<Abstract>
<Para>Returns a sample from the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to sample from. :return Random element from array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1120">
<Name>sortedIndex(_:value:)</Name>
<USR>s:FC6Dollar6Dollar11sortedIndexFMS0_USs10Comparable__FTGSaQ__5valueQ__Si</USR>
<Declaration>public class func sortedIndex&lt;T : Comparable&gt;(array: [T], value: T) -&gt; Int</Declaration>
<Abstract>
<Para>Gives the smallest index at which a value should be inserted into a given the array is sorted.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param value Find sorted index of this value. :return Index of where the elemnt should be inserted.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1134">
<Name>tap(_:function:)</Name>
<USR>s:FC6Dollar6Dollar3tapFMS0_U__FTQ_8functionFQ_T__Q_</USR>
<Declaration>public class func tap&lt;T&gt;(object: T, function: (T) -&gt; ()) -&gt; T</Declaration>
<Abstract>
<Para>Invokes interceptor with the object and then returns object.</Para>
</Abstract>
<Discussion>
<Para>:param object Object to tap into. :param function Callback function to invoke. :return Returns the object back.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1145">
<Name>times(_:function:)</Name>
<USR>s:FC6Dollar6Dollar5timesFMS0_U__FTSi8functionFT_Q__GSaQ__</USR>
<Declaration>public class func times&lt;T&gt;(n: Int, function: () -&gt; T) -&gt; [T]</Declaration>
<Abstract>
<Para>Call a function n times and also passes the index. If a value is returned in the function then the times method will return an array of those values.</Para>
</Abstract>
<Discussion>
<Para>:param n Number of times to call function. :param function The function to be called every time. :return Values returned from callback function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1168">
<Name>times(_:function:)</Name>
<USR>s:FC6Dollar6Dollar5timesFMS0_U__FTSi8functionFSiQ__GSaQ__</USR>
<Declaration>public class func times&lt;T&gt;(n: Int, function: (Int) -&gt; T) -&gt; [T]</Declaration>
<Abstract>
<Para>Call a function n times and also passes the index. If a value is returned in the function then the times method will return an array of those values.</Para>
</Abstract>
<Discussion>
<Para>:param n Number of times to call function. :param function The function to be called every time that takes index. :return Values returned from callback function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1156">
<Name>times(_:function:)</Name>
<USR>s:FC6Dollar6Dollar5timesFMS0_FTSi8functionFT_T__T_</USR>
<Declaration>public class func times(n: Int, function: () -&gt; ())</Declaration>
<Abstract>
<Para>Call a function n times and also passes the index. If a value is returned in the function then the times method will return an array of those values.</Para>
</Abstract>
<Discussion>
<Para>:param n Number of times to call function. :param function The function to be called every time.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1180">
<Name>union(_:)</Name>
<USR>s:FC6Dollar6Dollar5unionFMS0_USs8Hashable__FtGSaGSaQ____GSaQ__</USR>
<Declaration>public class func union&lt;T : Hashable&gt;(arrays: [T]...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of unique values, in order, of the provided arrays.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to perform union on. :return Resulting array after union.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1198">
<Name>uniq(_:)</Name>
<USR>s:FC6Dollar6Dollar4uniqFMS0_USs8Hashable__FGSaQ__GSaQ__</USR>
<Declaration>public class func uniq&lt;T : Hashable&gt;(array: [T]) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates a duplicate-value-free version of an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return An array with unique values.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1214">
<Name>values(_:)</Name>
<USR>s:FC6Dollar6Dollar6valuesFMS0_USs8Hashable___FGVSs10DictionaryQ_Q0__GSaQ0__</USR>
<Declaration>public class func values&lt;T, U&gt;(dictionary: [T : U]) -&gt; [U]</Declaration>
<Abstract>
<Para>Creates an array of values of a given dictionary.</Para>
</Abstract>
<Discussion>
<Para>:param dictionary The dictionary to source from. :return An array of values from the dictionary.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1227">
<Name>without(_:values:)</Name>
<USR>s:FC6Dollar6Dollar7withoutFMS0_USs9Equatable__FtGSaQ__6valuesGSaQ___GSaQ__</USR>
<Declaration>public class func without&lt;T : Equatable&gt;(array: [T], values: T...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array excluding all provided values.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param values Values to exclude. :return Array excluding provided values.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1235">
<Name>xor(_:)</Name>
<USR>s:FC6Dollar6Dollar3xorFMS0_USs8Hashable__FtGSaGSaQ____GSaQ__</USR>
<Declaration>public class func xor&lt;T : Hashable&gt;(arrays: [T]...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array that is the symmetric difference of the provided arrays.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to perform xor on in order. :return Resulting array after performing xor.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1256">
<Name>zip(_:)</Name>
<USR>s:FC6Dollar6Dollar3zipFMS0_FtGSaGSaPSs9AnyObject____GSaPS1___</USR>
<Declaration>public class func zip(arrays: [AnyObject]...) -&gt; [AnyObject]</Declaration>
<Abstract>
<Para>Creates an array of grouped elements, the first of which contains the first elements of the given arrays.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to be grouped. :return An array of grouped elements.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1274">
<Name>zipObject(_:values:)</Name>
<USR>s:FC6Dollar6Dollar9zipObjectFMS0_USs8Hashable___FTGSaQ__6valuesGSaQ0___GVSs10DictionaryQ_Q0__</USR>
<Declaration>public class func zipObject&lt;T, E&gt;(keys: [T], values: [E]) -&gt; [T : E]</Declaration>
<Abstract>
<Para>Creates an object composed from arrays of keys and values.</Para>
</Abstract>
<Discussion>
<Para>:param keys The array of keys. :param values The array of values. :return Dictionary based on the keys and values passed in order.</Para>
</Discussion>
</Function>
</jazzy>
Raw
Dollar.xml
<jazzy>
<Function column="12" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="40">
<Name>init(array:)</Name>
<USR>s:FC6Dollar6DollarcFMS0_FT5arrayGSaPSs9AnyObject___S0_</USR>
<Declaration>public init(array: [AnyObject])</Declaration>
<Abstract>
<Para>Initializer of the wrapper object for chaining.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="52">
<Name>first()</Name>
<USR>s:FC6Dollar6Dollar5firstFS0_FT_S0_</USR>
<Declaration>public func first() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the first object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return First element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="488">
<Name>first(_:)</Name>
<USR>s:FC6Dollar6Dollar5firstFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func first&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the first element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return First element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="61">
<Name>second()</Name>
<USR>s:FC6Dollar6Dollar6secondFS0_FT_S0_</USR>
<Declaration>public func second() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the second object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Second element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="500">
<Name>second(_:)</Name>
<USR>s:FC6Dollar6Dollar6secondFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func second&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the second element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Second element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="70">
<Name>third()</Name>
<USR>s:FC6Dollar6Dollar5thirdFS0_FT_S0_</USR>
<Declaration>public func third() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the third object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Third element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="512">
<Name>third(_:)</Name>
<USR>s:FC6Dollar6Dollar5thirdFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func third&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the third element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Third element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="79">
<Name>fourth()</Name>
<USR>s:FC6Dollar6Dollar6fourthFS0_FT_S0_</USR>
<Declaration>public func fourth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the fourth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Fourth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="524">
<Name>fourth(_:)</Name>
<USR>s:FC6Dollar6Dollar6fourthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func fourth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the fourth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Fourth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="88">
<Name>fifth()</Name>
<USR>s:FC6Dollar6Dollar5fifthFS0_FT_S0_</USR>
<Declaration>public func fifth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the fifth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Fifth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="536">
<Name>fifth(_:)</Name>
<USR>s:FC6Dollar6Dollar5fifthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func fifth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the fifth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Fifth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="97">
<Name>sixth()</Name>
<USR>s:FC6Dollar6Dollar5sixthFS0_FT_S0_</USR>
<Declaration>public func sixth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the sixth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Sixth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="548">
<Name>sixth(_:)</Name>
<USR>s:FC6Dollar6Dollar5sixthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func sixth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the sixth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Sixth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="106">
<Name>seventh()</Name>
<USR>s:FC6Dollar6Dollar7seventhFS0_FT_S0_</USR>
<Declaration>public func seventh() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the seventh object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Seventh element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="560">
<Name>seventh(_:)</Name>
<USR>s:FC6Dollar6Dollar7seventhFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func seventh&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the seventh element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Seventh element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="115">
<Name>eighth()</Name>
<USR>s:FC6Dollar6Dollar6eighthFS0_FT_S0_</USR>
<Declaration>public func eighth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the eighth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Eighth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="572">
<Name>eighth(_:)</Name>
<USR>s:FC6Dollar6Dollar6eighthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func eighth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the eighth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Eighth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="124">
<Name>ninth()</Name>
<USR>s:FC6Dollar6Dollar5ninthFS0_FT_S0_</USR>
<Declaration>public func ninth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the ninth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Ninth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="584">
<Name>ninth(_:)</Name>
<USR>s:FC6Dollar6Dollar5ninthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func ninth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the ninth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Ninth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="133">
<Name>tenth()</Name>
<USR>s:FC6Dollar6Dollar5tenthFS0_FT_S0_</USR>
<Declaration>public func tenth() -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the tenth object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:return Tenth element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="596">
<Name>tenth(_:)</Name>
<USR>s:FC6Dollar6Dollar5tenthFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func tenth&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the tenth element in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return Tenth element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="143">
<Name>flatten()</Name>
<USR>s:FC6Dollar6Dollar7flattenFS0_FT_S0_</USR>
<Declaration>public func flatten() -&gt; Dollar</Declaration>
<Abstract>
<Para>Another comment Flattens nested array.</Para>
</Abstract>
<Discussion>
<Para>:return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="608">
<Name>flatten(_:)</Name>
<USR>s:FC6Dollar6Dollar7flattenFMS0_FGSaPSs9AnyObject__GSaPS1___</USR>
<Declaration>public class func flatten(array: [AnyObject]) -&gt; [AnyObject]</Declaration>
<Abstract>
<Para>Flattens a nested array of any depth.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to flatten. :return Flattened array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="152">
<Name>initial()</Name>
<USR>s:FC6Dollar6Dollar7initialFS0_FT_S0_</USR>
<Declaration>public func initial() -&gt; Dollar</Declaration>
<Abstract>
<Para>Keeps all the elements except last one.</Para>
</Abstract>
<Discussion>
<Para>:return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="160">
<Name>initial(_:)</Name>
<USR>s:FC6Dollar6Dollar7initialFS0_FSiS0_</USR>
<Declaration>public func initial(numElements: Int) -&gt; Dollar</Declaration>
<Abstract>
<Para>Keeps all the elements except last n elements.</Para>
</Abstract>
<Discussion>
<Para>:param numElements Number of items to remove from the end of the array. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="688">
<Name>initial(_:numElements:)</Name>
<USR>s:FC6Dollar6Dollar7initialFMS0_U__FTGSaQ__11numElementsSi_GSaQ__</USR>
<Declaration>public class func initial&lt;T&gt;(array: [T], numElements: Int = default) -&gt; [T]</Declaration>
<Abstract>
<Para>Gets all but the last element or last n elements of an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param numElements The number of elements to ignore in the end. :return Array of initial values.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="170">
<Name>map(_:)</Name>
<USR>s:FC6Dollar6Dollar3mapFS0_FFPSs9AnyObject_PS1__S0_</USR>
<Declaration>public func map(function: (AnyObject) -&gt; AnyObject) -&gt; Dollar</Declaration>
<Abstract>
<Para>Maps elements to new elements.</Para>
</Abstract>
<Discussion>
<Para>:param function Function to map. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="184">
<Name>map(_:)</Name>
<USR>s:FC6Dollar6Dollar3mapFS0_FFTSiPSs9AnyObject__PS1__S0_</USR>
<Declaration>public func map(function: (Int, AnyObject) -&gt; AnyObject) -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the first object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="198">
<Name>each(_:)</Name>
<USR>s:FC6Dollar6Dollar4eachFS0_FFPSs9AnyObject_T_S0_</USR>
<Declaration>public func each(function: (AnyObject) -&gt; ()) -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the first object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="211">
<Name>each(_:)</Name>
<USR>s:FC6Dollar6Dollar4eachFS0_FFTSiPSs9AnyObject__T_S0_</USR>
<Declaration>public func each(function: (Int, AnyObject) -&gt; ()) -&gt; Dollar</Declaration>
<Abstract>
<Para>Get the first object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="224">
<Name>filter(_:)</Name>
<USR>s:FC6Dollar6Dollar6filterFS0_FFPSs9AnyObject_SbS0_</USR>
<Declaration>public func filter(function: (AnyObject) -&gt; Bool) -&gt; Dollar</Declaration>
<Abstract>
<Para>Filter elements based on the function passed.</Para>
</Abstract>
<Discussion>
<Para>:param function Function to tell whether to keep an element or remove. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="234">
<Name>all(_:)</Name>
<USR>s:FC6Dollar6Dollar3allFS0_FFPSs9AnyObject_SbS0_</USR>
<Declaration>public func all(function: (AnyObject) -&gt; Bool) -&gt; Dollar</Declaration>
<Abstract>
<Para>Returns if all elements in array are true based on the passed function.</Para>
</Abstract>
<Discussion>
<Para>:param function Function to tell whether element value is true or false. :return Whether all elements are true according to func function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="426">
<Name>every(_:iterator:)</Name>
<USR>s:FC6Dollar6Dollar5everyFMS0_U__FTGSaQ__8iteratorFQ_Sb_Sb</USR>
<Declaration>public class func every&lt;T&gt;(array: [T], iterator: (T) -&gt; Bool) -&gt; Bool</Declaration>
<Abstract>
<Para>Checks if the given callback returns true value for all items in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to check. :param iterator Check whether element value is true or false. :return First element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="244">
<Name>any(_:)</Name>
<USR>s:FC6Dollar6Dollar3anyFS0_FFPSs9AnyObject_SbS0_</USR>
<Declaration>public func any(function: (AnyObject) -&gt; Bool) -&gt; Dollar</Declaration>
<Abstract>
<Para>Returns if any element in array is true based on the passed function.</Para>
</Abstract>
<Discussion>
<Para>:param function Function to tell whether element value is true or false. :return Whether any one element is true according to func function in the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="260">
<Name>slice(_:end:)</Name>
<USR>s:FC6Dollar6Dollar5sliceFS0_FTSi3endSi_S0_</USR>
<Declaration>public func slice(start: Int, end: Int = default) -&gt; Dollar</Declaration>
<Abstract>
<Para>Slice the array into smaller size based on start and end value.</Para>
</Abstract>
<Discussion>
<Para>:param start Start index to start slicing from. :param end End index to stop slicing to and not including element at that index. :return The wrapper object.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1102">
<Name>slice(_:start:end:)</Name>
<USR>s:FC6Dollar6Dollar5sliceFMS0_U__FTGSaQ__5startSi3endSi_GSaQ__</USR>
<Declaration>public class func slice&lt;T&gt;(array: [T], start: Int, end: Int = default) -&gt; [T]</Declaration>
<Abstract>
<Para>Slices the array based on the start and end position. If an end position is not specified it will slice till the end of the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to slice. :param start Start index. :param end End index. :return First element from the array.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="269">
<Name>value()</Name>
<USR>s:FC6Dollar6Dollar5valueFS0_FT_GSqPSs9AnyObject__</USR>
<Declaration>public func value() -&gt; AnyObject?</Declaration>
<Abstract>
<Para>Get the final result from the wrapper object to terminated the chain.</Para>
</Abstract>
<Discussion>
<Para>:return Final resulting array from applying all functions on it.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="295">
<Name>after(_:function:)</Name>
<USR>s:FC6Dollar6Dollar5afterFMS0_U___FTSi8functionFtGSaQ___Q0__FtGSaQ___GSqQ0__</USR>
<Declaration>public class func after&lt;T, E&gt;(n: Int, function: (T...) -&gt; E) -&gt; ((T...) -&gt; E?)</Declaration>
<Discussion>
<Para>___ ___ _______ ___ ________ _______ ________</Para>
<Para>|\ \|\ \|\ ___ \ |\ \ |\ __ \|\ ___ \ |\ __ \ \ \ \\\ \ \ __/|\ \ \ \ \ \|\ \ \ __/|\ \ \|\ \</Para>
<Para>\ \ __ \ \ \_|/_\ \ \ \ \ ____\ \ \_|/_\ \ _ _\\ \ \ \ \ \ \_|\ \ \ \____\ \ \___|\ \ \_|\ \ \ \\ \|\ \__\ \__\ \_______\ \_______\ \__\ \ \_______\ \__\\ _\\|__|\|__|\|_______|\|_______|\|__| \|_______|\|__|\|__|</Para>
<Para>Creates a function that executes passed function only after being called n times.</Para>
<Para>:param n Number of times after which to call function. :param function Function to be called that takes params. :return Function that can be called n times after which the callback function is called.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="312">
<Name>after(_:function:)</Name>
<USR>s:FC6Dollar6Dollar5afterFMS0_U__FTSi8functionFT_Q__FT_GSqQ__</USR>
<Declaration>public class func after&lt;T&gt;(n: Int, function: () -&gt; T) -&gt; (() -&gt; T?)</Declaration>
<Abstract>
<Para>Creates a function that executes passed function only after being called n times.</Para>
</Abstract>
<Discussion>
<Para>:param n Number of times after which to call function. :param function Function to be called that does not take any params. :return Function that can be called n times after which the callback function is called.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="325">
<Name>at(_:indexes:)</Name>
<USR>s:FC6Dollar6Dollar2atFMS0_U__FtGSaQ__7indexesGSaSi__GSaQ__</USR>
<Declaration>public class func at&lt;T&gt;(array: [T], indexes: Int...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of elements from the specified indexes, or keys, of the collection. Indexes may be specified as individual arguments or as arrays of indexes.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from :param indexes Get elements from these indexes :return New array with elements from the indexes specified.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="335">
<Name>at(_:indexes:)</Name>
<USR>s:FC6Dollar6Dollar2atFMS0_U__FTGSaQ__7indexesGSaSi__GSaQ__</USR>
<Declaration>public class func at&lt;T&gt;(array: [T], indexes: [Int]) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of elements from the specified indexes, or keys, of the collection. Indexes may be specified as individual arguments or as arrays of indexes.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from :param indexes Get elements from these indexes :return New array with elements from the indexes specified.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="348">
<Name>bind(_:_:)</Name>
<USR>s:FC6Dollar6Dollar4bindFMS0_U___FtFtGSaQ___Q0_GSaQ___FT_Q0_</USR>
<Declaration>public class func bind&lt;T, E&gt;(function: (T...) -&gt; E, _ parameters: T...) -&gt; (() -&gt; E)</Declaration>
<Abstract>
<Para>Creates a function that, when called, invokes func with the binding of arguments provided.</Para>
</Abstract>
<Discussion>
<Para>:param function Function to be bound. :param parameters Parameters to be passed into the function when being invoked. :return A new function that when called will invoked the passed function with the parameters specified.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="360">
<Name>compact(_:)</Name>
<USR>s:FC6Dollar6Dollar7compactFMS0_U__FGSaGSqQ___GSaQ__</USR>
<Declaration>public class func compact&lt;T&gt;(array: [T?]) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array with all nil values removed.</Para>
</Abstract>
<Discussion>
<Para>:param array Array to be compacted. :return A new array that doesnt have any nil values.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="375">
<Name>contains(_:value:)</Name>
<USR>s:FC6Dollar6Dollar8containsFMS0_USs9Equatable__FTGSaQ__5valueQ__Sb</USR>
<Declaration>public class func contains&lt;T : Equatable&gt;(array: [T], value: T) -&gt; Bool</Declaration>
<Abstract>
<Para>Checks if a given value is present in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to check against. :param value The value to check. :return Whether value is in the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="383">
<Name>copy(_:)</Name>
<USR>s:FC6Dollar6Dollar4copyFMS0_U__FGSaQ__GSaQ__</USR>
<Declaration>public class func copy&lt;T&gt;(array: [T]) -&gt; [T]</Declaration>
<Abstract>
<Para>Create a copy of an array</Para>
</Abstract>
<Discussion>
<Para>:param array The array to copy :return New copy of array</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="395">
<Name>difference(_:)</Name>
<USR>s:FC6Dollar6Dollar10differenceFMS0_USs8Hashable__FtGSaGSaQ____GSaQ__</USR>
<Declaration>public class func difference&lt;T : Hashable&gt;(arrays: [T]...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array excluding all values of the provided arrays.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to difference between. :return The difference between the first array and all the remaining arrays from the arrays params.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1078">
<Name>rest(_:numElements:)</Name>
<USR>s:FC6Dollar6Dollar4restFMS0_U__FTGSaQ__11numElementsSi_GSaQ__</USR>
<Declaration>public class func rest&lt;T&gt;(array: [T], numElements: Int = default) -&gt; [T]</Declaration>
<Abstract>
<Para>The opposite of initial this method gets all but the first element or first n elements of an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param numElements The number of elements to exclude from the beginning. :return The rest of the elements.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="441">
<Name>find(_:iterator:)</Name>
<USR>s:FC6Dollar6Dollar4findFMS0_USs9Equatable__FTGSaQ__8iteratorFQ_Sb_GSqQ__</USR>
<Declaration>public class func find&lt;T : Equatable&gt;(array: [T], iterator: (T) -&gt; Bool) -&gt; T?</Declaration>
<Abstract>
<Para>Iterates over elements of an array and returning the first element that the callback returns true for.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to search for the element in. :param iterator The iterator function to tell whether element is found. :return Optional containing either found element or nil.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="457">
<Name>findIndex(_:iterator:)</Name>
<USR>s:FC6Dollar6Dollar9findIndexFMS0_U__FTGSaQ__8iteratorFQ_Sb_GSqSi_</USR>
<Declaration>public class func findIndex&lt;T&gt;(array: [T], iterator: (T) -&gt; Bool) -&gt; Int?</Declaration>
<Abstract>
<Para>This method is like find except that it returns the index of the first element that passes the callback check.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to search for the element in. :param iterator Function used to figure out whether element is the same. :return First element's index from the array found using the iterator.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="472">
<Name>findLastIndex(_:iterator:)</Name>
<USR>s:FC6Dollar6Dollar13findLastIndexFMS0_U__FTGSaQ__8iteratorFQ_Sb_GSqSi_</USR>
<Declaration>public class func findLastIndex&lt;T&gt;(array: [T], iterator: (T) -&gt; Bool) -&gt; Int?</Declaration>
<Abstract>
<Para>This method is like findIndex except that it iterates over elements of the array from right to left.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to search for the element in. :param iterator Function used to figure out whether element is the same. :return Last element's index from the array found using the iterator.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="624">
<Name>shuffle(_:)</Name>
<USR>s:FC6Dollar6Dollar7shuffleFMS0_U__FGSaQ__GSaQ__</USR>
<Declaration>public class func shuffle&lt;T&gt;(array: [T]) -&gt; [T]</Declaration>
<Abstract>
<Para>Randomly shuffles the elements of an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to shuffle. :return Shuffled array</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="642">
<Name>frequencies(_:)</Name>
<USR>s:FC6Dollar6Dollar11frequenciesFMS0_USs8Hashable__FGSaQ__GVSs10DictionaryQ_Si_</USR>
<Declaration>public class func frequencies&lt;T&gt;(array: [T]) -&gt; [T : Int]</Declaration>
<Abstract>
<Para>This method returns a dictionary of values in an array mapping to the total number of occurrences in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return Dictionary that contains the key generated from the element passed in the function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="653">
<Name>frequencies(_:function:)</Name>
<USR>s:FC6Dollar6Dollar11frequenciesFMS0_U_Ss8Hashable__FTGSaQ__8functionFQ_Q0__GVSs10DictionaryQ0_Si_</USR>
<Declaration>public class func frequencies&lt;T, U : Equatable&gt;(array: [T], function: (T) -&gt; U) -&gt; [U : Int]</Declaration>
<Abstract>
<Para>This method returns a dictionary of values in an array mapping to the total number of occurrences in the array. If passed a function it returns a frequency table of the results of the given function on the arrays elements.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param function The function to get value of the key for each element to group by. :return Dictionary that contains the key generated from the element passed in the function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="670">
<Name>id(_:)</Name>
<USR>s:FC6Dollar6Dollar2idFMS0_U__FQ_Q_</USR>
<Declaration>public class func id&lt;T&gt;(arg: T) -&gt; T</Declaration>
<Abstract>
<Para>The identity function. Returns the argument it is given.</Para>
</Abstract>
<Discussion>
<Para>:param arg Value to return :return Argument that was passed</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="679">
<Name>indexOf(_:value:)</Name>
<USR>s:FC6Dollar6Dollar7indexOfFMS0_USs9Equatable__FTGSaQ__5valueQ__GSqSi_</USR>
<Declaration>public class func indexOf&lt;T : Equatable&gt;(array: [T], value: T) -&gt; Int?</Declaration>
<Abstract>
<Para>Gets the index at which the first occurrence of value is found.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param value Value whose index needs to be found. :return Index of the element otherwise returns nil if not found.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="702">
<Name>intersection(_:)</Name>
<USR>s:FC6Dollar6Dollar12intersectionFMS0_USs8Hashable__FtGSaGSaQ____GSaQ__</USR>
<Declaration>public class func intersection&lt;T : Hashable&gt;(arrays: [T]...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of unique values present in all provided arrays.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to perform an intersection on. :return Intersection of all arrays passed.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="728">
<Name>join(_:separator:)</Name>
<USR>s:FC6Dollar6Dollar4joinFMS0_USs24ExtensibleCollectionType_USs13GeneratorType__Ss16ForwardIndexType_Ss18_SignedIntegerType_Ss33_BuiltinIntegerLiteralConvertible____FTGSaQ__9separatorQ__Q_</USR>
<Declaration>public class func join&lt;T : ExtensibleCollectionType&gt;(array: [T], separator: T) -&gt; T</Declaration>
<Abstract>
<Para>Joins the elements in the array to create a concatenated element of the same type.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to join the elements of. :param separator The separator to join the elements with. :return Joined element from the array of elements.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="736">
<Name>keys(_:)</Name>
<USR>s:FC6Dollar6Dollar4keysFMS0_USs8Hashable___FGVSs10DictionaryQ_Q0__GSaQ__</USR>
<Declaration>public class func keys&lt;T, U&gt;(dictionary: [T : U]) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of keys given a dictionary.</Para>
</Abstract>
<Discussion>
<Para>:param dictionary The dictionary to source from. :return Array of keys from dictionary.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="748">
<Name>last(_:)</Name>
<USR>s:FC6Dollar6Dollar4lastFMS0_U__FGSaQ__GSqQ__</USR>
<Declaration>public class func last&lt;T&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Gets the last element from the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return Last element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="761">
<Name>lastIndexOf(_:value:)</Name>
<USR>s:FC6Dollar6Dollar11lastIndexOfFMS0_USs9Equatable__FTGSaQ__5valueQ__GSqSi_</USR>
<Declaration>public class func lastIndexOf&lt;T : Equatable&gt;(array: [T], value: T) -&gt; Int?</Declaration>
<Abstract>
<Para>Gets the index at which the last occurrence of value is found.</Para>
</Abstract>
<Discussion>
<Para>param: array:: The array to source from. :param value The value whose last index needs to be found. :return Last index of element if found otherwise returns nil.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="770">
<Name>map(_:transform:)</Name>
<USR>s:FC6Dollar6Dollar3mapFMS0_U___FTGSaQ__9transformFQ_Q0__GSaQ0__</USR>
<Declaration>public class func map&lt;T, E&gt;(array: [T], transform: (T) -&gt; E) -&gt; [E]</Declaration>
<Abstract>
<Para>Maps each element to new value based on the map function passed</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param transform The mapping function :return Array of elements mapped using the map function</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="778">
<Name>max(_:)</Name>
<USR>s:FC6Dollar6Dollar3maxFMS0_USs10Comparable__FGSaQ__GSqQ__</USR>
<Declaration>public class func max&lt;T : Comparable&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Retrieves the maximum value in an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return Maximum element in array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="792">
<Name>memoize(_:)</Name>
<USR>s:FC6Dollar6Dollar7memoizeFMS0_USs8Hashable___FFTFQ_Q0_Q__Q0_FQ_Q0_</USR>
<Declaration>public class func memoize&lt;T : Hashable, U&gt;(function: ((T -&gt; U), T) -&gt; U) -&gt; (T -&gt; U)</Declaration>
<Abstract>
<Para>Get memoized function to improve performance</Para>
</Abstract>
<Discussion>
<Para>:param function The function to memoize. :return Memoized function</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="810">
<Name>merge(dictionaries:)</Name>
<USR>s:FC6Dollar6Dollar5mergeFMS0_USs8Hashable___Ft12dictionariesGSaGVSs10DictionaryQ_Q0____GS2_Q_Q0__</USR>
<Declaration>public class func merge&lt;T, U&gt;(#dictionaries: [T : U]...) -&gt; [T : U]</Declaration>
<Abstract>
<Para>Merge dictionaries together, later dictionaries overiding earlier values of keys.</Para>
</Abstract>
<Discussion>
<Para>:param dictionaries The dictionaries to source from. :return Merged dictionary with all of its keys and values.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="824">
<Name>merge(arrays:)</Name>
<USR>s:FC6Dollar6Dollar5mergeFMS0_U__Ft6arraysGSaGSaQ____GSaQ__</USR>
<Declaration>public class func merge&lt;T&gt;(#arrays: [T]...) -&gt; [T]</Declaration>
<Abstract>
<Para>Merge arrays together in the supplied order.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to source from. :return Array with all values merged, including duplicates.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="836">
<Name>min(_:)</Name>
<USR>s:FC6Dollar6Dollar3minFMS0_USs10Comparable__FGSaQ__GSqQ__</USR>
<Declaration>public class func min&lt;T : Comparable&gt;(array: [T]) -&gt; T?</Declaration>
<Abstract>
<Para>Retrieves the minimum value in an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return Minimum value from array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="849">
<Name>noop()</Name>
<USR>s:FC6Dollar6Dollar4noopFMS0_FT_GSqPSs9AnyObject__</USR>
<Declaration>public class func noop() -&gt; AnyObject?</Declaration>
<Abstract>
<Para>A no-operation function.</Para>
</Abstract>
<Discussion>
<Para>:return nil.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="858">
<Name>omit(_:keys:)</Name>
<USR>s:FC6Dollar6Dollar4omitFMS0_USs8Hashable___FtGVSs10DictionaryQ_Q0__4keysGSaQ___GS2_Q_Q0__</USR>
<Declaration>public class func omit&lt;T, U&gt;(dictionary: [T : U], keys: T...) -&gt; [T : U]</Declaration>
<Abstract>
<Para>Creates a shallow clone of a dictionary excluding the specified keys.</Para>
</Abstract>
<Discussion>
<Para>:param dictionary The dictionary to source from. :param keys The keys to omit from returning dictionary. :return Dictionary with the keys specified omitted.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="873">
<Name>partial(_:_:)</Name>
<USR>s:FC6Dollar6Dollar7partialFMS0_U___FtFtGSaQ___Q0_GSaQ___FtGSaQ___Q0_</USR>
<Declaration>public class func partial&lt;T, E&gt;(function: (T...) -&gt; E, _ parameters: T...) -&gt; ((T...) -&gt; E)</Declaration>
<Abstract>
<Para>Get the first object in the wrapper object.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :return First element from the array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="888">
<Name>partition(_:n:step:)</Name>
<USR>s:FC6Dollar6Dollar9partitionFMS0_U__FTGSaQ__1nSi4stepGSqSi__GSaGSaQ___</USR>
<Declaration>public class func partition&lt;T&gt;(array: [T], n: Int, step: Int? = default) -&gt; [[T]]</Declaration>
<Abstract>
<Para>Produces an array of arrays, each containing n elements, each offset by step. If the final partition is not n elements long it is dropped.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to partition. :param n The number of elements in each partition. :param step The number of elements to progress between each partition. Set to n if not supplied. :return Array partitioned into n element arrays, starting step elements apart.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1041">
<Name>range(_:endVal:incrementBy:)</Name>
<USR>s:FC6Dollar6Dollar5rangeFMS0_USs10Strideable_USs16SignedNumberType_Ss33_BuiltinIntegerLiteralConvertible__FTQ_6endValQ_11incrementByQQ_6Stride_GSaQ__</USR>
<Declaration>public class func range&lt;T : Strideable&gt;(startVal: T, endVal: T, incrementBy: T.Stride) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of numbers (positive and/or negative) progressing from start up to but not including end.</Para>
</Abstract>
<Discussion>
<Para>:param startVal Start value of range. :param endVal End value of range. :param incrementBy Increment sequence by. :return Array of elements based on the sequence.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="910">
<Name>partition(_:n:step:pad:)</Name>
<USR>s:FC6Dollar6Dollar9partitionFMS0_U__FTGSaQ__1nSi4stepGSqSi_3padGSqGSaQ____GSaGSaQ___</USR>
<Declaration>public class func partition&lt;T&gt;(array: [T], n: Int, step: Int? = default, pad: [T]?) -&gt; [[T]]</Declaration>
<Abstract>
<Para>Produces an array of arrays, each containing n elements, each offset by step.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to partition. :param n The number of elements in each partition. :param step The number of elements to progress between each partition. Set to n if not supplied. :param pad An array of elements to pad the last partition if it is not long enough to</Para>
<Para>contain n elements. If nil is passed or there are not enough pad elements the last partition may less than n elements long.</Para>
<Para>:return Array partitioned into n element arrays, starting step elements apart.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="937">
<Name>partitionAll(_:n:step:)</Name>
<USR>s:FC6Dollar6Dollar12partitionAllFMS0_U__FTGSaQ__1nSi4stepGSqSi__GSaGSaQ___</USR>
<Declaration>public class func partitionAll&lt;T&gt;(array: [T], n: Int, step: Int? = default) -&gt; [[T]]</Declaration>
<Abstract>
<Para>Produces an array of arrays, each containing n elements, each offset by step.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to partition. :param n The number of elements in each partition. :param step The number of elements to progress between each partition. Set to n if not supplied. :return Array partitioned into n element arrays, starting step elements apart.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="956">
<Name>partitionBy(_:function:)</Name>
<USR>s:FC6Dollar6Dollar11partitionByFMS0_U_Ss9Equatable__FTGSaQ__8functionFQ_Q0__GSaGSaQ___</USR>
<Declaration>public class func partitionBy&lt;T, U : Equatable&gt;(array: [T], function: (T) -&gt; U) -&gt; [[T]]</Declaration>
<Abstract>
<Para>Applies function to each element in array, splitting it each time function returns a new value.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to partition. :param function Function which takes an element and produces an equatable result. :return Array partitioned in order, splitting via results of function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="978">
<Name>pick(_:keys:)</Name>
<USR>s:FC6Dollar6Dollar4pickFMS0_USs8Hashable___FtGVSs10DictionaryQ_Q0__4keysGSaQ___GS2_Q_Q0__</USR>
<Declaration>public class func pick&lt;T, U&gt;(dictionary: [T : U], keys: T...) -&gt; [T : U]</Declaration>
<Abstract>
<Para>Creates a shallow clone of a dictionary composed of the specified keys.</Para>
</Abstract>
<Discussion>
<Para>:param dictionary The dictionary to source from. :param keys The keys to pick values from. :return Dictionary with the key and values picked from the keys specified.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="991">
<Name>pluck(_:value:)</Name>
<USR>s:FC6Dollar6Dollar5pluckFMS0_USs8Hashable___FTGSaGVSs10DictionaryQ_Q0___5valueQ__GSaQ0__</USR>
<Declaration>public class func pluck&lt;T, E&gt;(array: [[T : E]], value: T) -&gt; [E]</Declaration>
<Abstract>
<Para>Retrieves the value of a specified property from all elements in the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param value The property on object to pull out value from. :return Array of values from array of objects with property of value.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1005">
<Name>pull(_:values:)</Name>
<USR>s:FC6Dollar6Dollar4pullFMS0_USs9Equatable__FtGSaQ__6valuesGSaQ___GSaQ__</USR>
<Declaration>public class func pull&lt;T : Equatable&gt;(array: [T], values: T...) -&gt; [T]</Declaration>
<Abstract>
<Para>Removes all provided values from the given array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return Array with values pulled out.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1014">
<Name>pull(_:values:)</Name>
<USR>s:FC6Dollar6Dollar4pullFMS0_USs9Equatable__FTGSaQ__6valuesGSaQ___GSaQ__</USR>
<Declaration>public class func pull&lt;T : Equatable&gt;(array: [T], values: [T]) -&gt; [T]</Declaration>
<Abstract>
<Para>Removes all provided values from the given array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param values The values to remove. :return Array with values pulled out.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1022">
<Name>range(_:)</Name>
<USR>s:FC6Dollar6Dollar5rangeFMS0_USs25IntegerLiteralConvertibleSs10Strideable_USs33_BuiltinIntegerLiteralConvertible_Ss16SignedNumberType_S3___FQ_GSaQ__</USR>
<Declaration>public class func range&lt;T : Strideable where T : IntegerLiteralConvertible&gt;(endVal: T) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of numbers (positive and/or negative) progressing from start up to but not including end.</Para>
</Abstract>
<Discussion>
<Para>:param endVal End value of range. :return Array of elements based on the sequence starting from 0 to endVal and incremented by 1.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1031">
<Name>range(_:endVal:)</Name>
<USR>s:FC6Dollar6Dollar5rangeFMS0_USs10Strideable_USs16SignedNumberType_Ss33_BuiltinIntegerLiteralConvertible__FTQ_6endValQ__GSaQ__</USR>
<Declaration>public class func range&lt;T : Strideable where T.Stride : IntegerLiteralConvertible&gt;(startVal: T, endVal: T) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of numbers (positive and/or negative) progressing from start up to but not including end.</Para>
</Abstract>
<Discussion>
<Para>:param startVal Start value of range :param endVal End value of range :return Array of elements based on the sequence that is incremented by 1</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1060">
<Name>sequence(_:)</Name>
<USR>s:FC6Dollar6Dollar8sequenceFMS0_USs12SequenceType_USs13GeneratorType___FQ_GSaQQQ_9Generator7Element_</USR>
<Declaration>public class func sequence&lt;S : SequenceType&gt;(seq: S) -&gt; [S.Generator.Element]</Declaration>
<Abstract>
<Para>Creates an array of an arbitrary sequence. Especially useful with builtin ranges.</Para>
</Abstract>
<Discussion>
<Para>:param seq The sequence to generate from. :return Array of elements generated from the sequence.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1052">
<Name>reduce(_:initial:combine:)</Name>
<USR>s:FC6Dollar6Dollar6reduceFMS0_U___FTGSaQ0__7initialQ_7combineFTQ_Q0__Q__Q_</USR>
<Declaration>public class func reduce&lt;U, T&gt;(array: [T], initial: U, combine: (U, T) -&gt; U) -&gt; U</Declaration>
<Abstract>
<Para>Reduce function that will resolve to one value after performing combine function on all elements</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param initial Initial value to seed the reduce function with :param combine Function that will combine the passed value with element in the array :return The result of reducing all of the elements in the array into one value</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1069">
<Name>remove(_:iterator:)</Name>
<USR>s:FC6Dollar6Dollar6removeFMS0_U__FTGSaQ__8iteratorFQ_Sb_GSaQ__</USR>
<Declaration>public class func remove&lt;T&gt;(array: [T], iterator: (T) -&gt; Bool) -&gt; [T]</Declaration>
<Abstract>
<Para>Removes all elements from an array that the callback returns true.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to wrap. :param iterator Remove elements for which iterator returns true. :return Array with elements filtered out.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1092">
<Name>sample(_:)</Name>
<USR>s:FC6Dollar6Dollar6sampleFMS0_U__FGSaQ__Q_</USR>
<Declaration>public class func sample&lt;T&gt;(array: [T]) -&gt; T</Declaration>
<Abstract>
<Para>Returns a sample from the array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to sample from. :return Random element from array.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1120">
<Name>sortedIndex(_:value:)</Name>
<USR>s:FC6Dollar6Dollar11sortedIndexFMS0_USs10Comparable__FTGSaQ__5valueQ__Si</USR>
<Declaration>public class func sortedIndex&lt;T : Comparable&gt;(array: [T], value: T) -&gt; Int</Declaration>
<Abstract>
<Para>Gives the smallest index at which a value should be inserted into a given the array is sorted.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param value Find sorted index of this value. :return Index of where the elemnt should be inserted.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1134">
<Name>tap(_:function:)</Name>
<USR>s:FC6Dollar6Dollar3tapFMS0_U__FTQ_8functionFQ_T__Q_</USR>
<Declaration>public class func tap&lt;T&gt;(object: T, function: (T) -&gt; ()) -&gt; T</Declaration>
<Abstract>
<Para>Invokes interceptor with the object and then returns object.</Para>
</Abstract>
<Discussion>
<Para>:param object Object to tap into. :param function Callback function to invoke. :return Returns the object back.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1145">
<Name>times(_:function:)</Name>
<USR>s:FC6Dollar6Dollar5timesFMS0_U__FTSi8functionFT_Q__GSaQ__</USR>
<Declaration>public class func times&lt;T&gt;(n: Int, function: () -&gt; T) -&gt; [T]</Declaration>
<Abstract>
<Para>Call a function n times and also passes the index. If a value is returned in the function then the times method will return an array of those values.</Para>
</Abstract>
<Discussion>
<Para>:param n Number of times to call function. :param function The function to be called every time. :return Values returned from callback function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1168">
<Name>times(_:function:)</Name>
<USR>s:FC6Dollar6Dollar5timesFMS0_U__FTSi8functionFSiQ__GSaQ__</USR>
<Declaration>public class func times&lt;T&gt;(n: Int, function: (Int) -&gt; T) -&gt; [T]</Declaration>
<Abstract>
<Para>Call a function n times and also passes the index. If a value is returned in the function then the times method will return an array of those values.</Para>
</Abstract>
<Discussion>
<Para>:param n Number of times to call function. :param function The function to be called every time that takes index. :return Values returned from callback function.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1156">
<Name>times(_:function:)</Name>
<USR>s:FC6Dollar6Dollar5timesFMS0_FTSi8functionFT_T__T_</USR>
<Declaration>public class func times(n: Int, function: () -&gt; ())</Declaration>
<Abstract>
<Para>Call a function n times and also passes the index. If a value is returned in the function then the times method will return an array of those values.</Para>
</Abstract>
<Discussion>
<Para>:param n Number of times to call function. :param function The function to be called every time.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1180">
<Name>union(_:)</Name>
<USR>s:FC6Dollar6Dollar5unionFMS0_USs8Hashable__FtGSaGSaQ____GSaQ__</USR>
<Declaration>public class func union&lt;T : Hashable&gt;(arrays: [T]...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array of unique values, in order, of the provided arrays.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to perform union on. :return Resulting array after union.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1198">
<Name>uniq(_:)</Name>
<USR>s:FC6Dollar6Dollar4uniqFMS0_USs8Hashable__FGSaQ__GSaQ__</USR>
<Declaration>public class func uniq&lt;T : Hashable&gt;(array: [T]) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates a duplicate-value-free version of an array.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :return An array with unique values.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1214">
<Name>values(_:)</Name>
<USR>s:FC6Dollar6Dollar6valuesFMS0_USs8Hashable___FGVSs10DictionaryQ_Q0__GSaQ0__</USR>
<Declaration>public class func values&lt;T, U&gt;(dictionary: [T : U]) -&gt; [U]</Declaration>
<Abstract>
<Para>Creates an array of values of a given dictionary.</Para>
</Abstract>
<Discussion>
<Para>:param dictionary The dictionary to source from. :return An array of values from the dictionary.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1227">
<Name>without(_:values:)</Name>
<USR>s:FC6Dollar6Dollar7withoutFMS0_USs9Equatable__FtGSaQ__6valuesGSaQ___GSaQ__</USR>
<Declaration>public class func without&lt;T : Equatable&gt;(array: [T], values: T...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array excluding all provided values.</Para>
</Abstract>
<Discussion>
<Para>:param array The array to source from. :param values Values to exclude. :return Array excluding provided values.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1235">
<Name>xor(_:)</Name>
<USR>s:FC6Dollar6Dollar3xorFMS0_USs8Hashable__FtGSaGSaQ____GSaQ__</USR>
<Declaration>public class func xor&lt;T : Hashable&gt;(arrays: [T]...) -&gt; [T]</Declaration>
<Abstract>
<Para>Creates an array that is the symmetric difference of the provided arrays.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to perform xor on in order. :return Resulting array after performing xor.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1256">
<Name>zip(_:)</Name>
<USR>s:FC6Dollar6Dollar3zipFMS0_FtGSaGSaPSs9AnyObject____GSaPS1___</USR>
<Declaration>public class func zip(arrays: [AnyObject]...) -&gt; [AnyObject]</Declaration>
<Abstract>
<Para>Creates an array of grouped elements, the first of which contains the first elements of the given arrays.</Para>
</Abstract>
<Discussion>
<Para>:param arrays The arrays to be grouped. :return An array of grouped elements.</Para>
</Discussion>
</Function>
<Function column="23" file="/Users/jp/Projects/Dollar.swift/Dollar/Dollar/Dollar.swift" line="1274">
<Name>zipObject(_:values:)</Name>
<USR>s:FC6Dollar6Dollar9zipObjectFMS0_USs8Hashable___FTGSaQ__6valuesGSaQ0___GVSs10DictionaryQ_Q0__</USR>
<Declaration>public class func zipObject&lt;T, E&gt;(keys: [T], values: [E]) -&gt; [T : E]</Declaration>
<Abstract>
<Para>Creates an object composed from arrays of keys and values.</Para>
</Abstract>
<Discussion>
<Para>:param keys The array of keys. :param values The array of values. :return Dictionary based on the keys and values passed in order.</Para>
</Discussion>
</Function>
</jazzy>
Raw
QueryKit.xml
<jazzy>
<Function column="24" file="/Users/jp/Projects/QueryKit/QueryKit/Attribute.swift" line="19">
<Name>init(attributes:)</Name>
<USR>s:FC8QueryKit9AttributecU__FMGS0_Q__FT10attributesGSaSS__GS0_Q__</USR>
<Declaration>public convenience init(attributes: Array&lt;String&gt;)</Declaration>
<Abstract>
<Para>Builds a compound attribute with other key paths</Para>
</Abstract>
</Function>
<Function column="20" file="/Users/jp/Projects/QueryKit/QueryKit/Attribute.swift" line="68">
<Name>!(_:)</Name>
<USR>s:F8QueryKitop1nFGCS_9AttributeSb_CSo11NSPredicate</USR>
<Declaration>prefix public func !(left: Attribute&lt;Bool&gt;) -&gt; NSPredicate</Declaration>
<Abstract>
<Para>MARK: Bool Attributes</Para>
</Abstract>
</Function>
<Class column="14" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="14">
<Name>QuerySet</Name>
<USR>s:C8QueryKit8QuerySet</USR>
<Declaration>public class QuerySet&lt;T : NSManagedObject&gt; : SequenceType, Equatable</Declaration>
<Abstract>
<Para>Represents a lazy database lookup for a set of objects.</Para>
</Abstract>
</Class>
<Other column="16" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="16">
<Name>context</Name>
<USR>s:vC8QueryKit8QuerySet7contextCSo22NSManagedObjectContext</USR>
<Declaration>public let context: NSManagedObjectContext</Declaration>
<Abstract>
<Para>Returns the managed object context that will be used to execute any requests.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="19">
<Name>entityName</Name>
<USR>s:vC8QueryKit8QuerySet10entityNameSS</USR>
<Declaration>public let entityName: String</Declaration>
<Abstract>
<Para>Returns the name of the entity the request is configured to fetch.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="22">
<Name>sortDescriptors</Name>
<USR>s:vC8QueryKit8QuerySet15sortDescriptorsGSaCSo16NSSortDescriptor_</USR>
<Declaration>public let sortDescriptors: [(NSSortDescriptor)]</Declaration>
<Abstract>
<Para>Returns the sort descriptors of the receiver.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="25">
<Name>predicate</Name>
<USR>s:vC8QueryKit8QuerySet9predicateGSqCSo11NSPredicate_</USR>
<Declaration>public let predicate: NSPredicate?</Declaration>
<Abstract>
<Para>Returns the predicate of the receiver.</Para>
</Abstract>
</Other>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="51">
<Name>orderBy(_:)</Name>
<USR>s:FC8QueryKit8QuerySet7orderByU__FGS0_Q__FCSo16NSSortDescriptorGS0_Q__</USR>
<Declaration>public func orderBy(sortDescriptor: NSSortDescriptor) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects ordered by the given sort descriptor.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="56">
<Name>orderBy(_:)</Name>
<USR>s:FC8QueryKit8QuerySet7orderByU__FGS0_Q__FGSaCSo16NSSortDescriptor_GS0_Q__</USR>
<Declaration>public func orderBy(sortDescriptors: [NSSortDescriptor]) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects ordered by the given sort descriptors.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="61">
<Name>reverse()</Name>
<USR>s:FC8QueryKit8QuerySet7reverseU__FGS0_Q__FT_GS0_Q__</USR>
<Declaration>public func reverse() -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Reverses the ordering of the QuerySet</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="68">
<Name>filter(_:)</Name>
<USR>s:FC8QueryKit8QuerySet6filterU__FGS0_Q__FCSo11NSPredicateGS0_Q__</USR>
<Declaration>public func filter(predicate: NSPredicate) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects that match the given predicate.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="79">
<Name>filter(_:)</Name>
<USR>s:FC8QueryKit8QuerySet6filterU__FGS0_Q__FGSaCSo11NSPredicate_GS0_Q__</USR>
<Declaration>public func filter(predicates: [NSPredicate]) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects that match the given predicates.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="85">
<Name>exclude(_:)</Name>
<USR>s:FC8QueryKit8QuerySet7excludeU__FGS0_Q__FCSo11NSPredicateGS0_Q__</USR>
<Declaration>public func exclude(predicate: NSPredicate) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects that exclude the given predicate.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="91">
<Name>exclude(_:)</Name>
<USR>s:FC8QueryKit8QuerySet7excludeU__FGS0_Q__FGSaCSo11NSPredicate_GS0_Q__</USR>
<Declaration>public func exclude(predicates: [NSPredicate]) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects that exclude the given predicates.</Para>
</Abstract>
</Function>
<Other column="12" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="114">
<Name>subscript(_:)</Name>
<USR>s:sC8QueryKit8QuerySet9subscriptFSiGSqQ__</USR>
<Declaration>public subscript (index: Int) -&gt; T? { get }</Declaration>
<Abstract>
<Para>Returns the object at the specified index.</Para>
</Abstract>
</Other>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="171">
<Name>count()</Name>
<USR>s:FC8QueryKit8QuerySet5countU__FGS0_Q__FT_GSqSi_</USR>
<Declaration>public func count() -&gt; Int?</Declaration>
<Abstract>
<Para>Returns the count of objects matching the QuerySet.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="180">
<Name>exists()</Name>
<USR>s:FC8QueryKit8QuerySet6existsU__FGS0_Q__FT_GSqSb_</USR>
<Declaration>public func exists() -&gt; Bool?</Declaration>
<Discussion>
<Para>Returns true if the QuerySet contains any results, and false if not.noteReturns nil if the operation could not be completed.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="193">
<Name>delete()</Name>
<USR>s:FC8QueryKit8QuerySet6deleteU__FGS0_Q__FT_T5countSi5errorGSqCSo7NSError__</USR>
<Declaration>public func delete() -&gt; (count: Int, error: NSError?)</Declaration>
<Abstract>
<Para>Deletes all the objects matching the QuerySet.</Para>
</Abstract>
</Function>
</jazzy>
Raw
SwiftyJSON.xml
<jazzy>
<Function column="12" file="/Users/jp/Projects/SwiftyJSON/Source/SwiftyJSON.swift" line="97">
<Name>init(data:options:error:)</Name>
<USR>s:FV10SwiftyJSON4JSONcFMS0_FT4dataCSo6NSData7optionsVSC20NSJSONReadingOptions5errorGVSs33AutoreleasingUnsafeMutablePointerGSqCSo7NSError___S0_</USR>
<Declaration>public init(data: NSData, options opt: NSJSONReadingOptions = default, error: NSErrorPointer = default)</Declaration>
<Parameters>
<Parameter>
<Name>data</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The NSData used to convert to json.Top level object in data is an NSArray or NSDictionary</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>options</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The JSON serialization reading options. `.AllowFragments` by default.</Para>
</Discussion>
</Parameter>
<Parameter>
<Name>error</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The NSErrorPointer used to return the error. `nil` by default.</Para>
</Discussion>
</Parameter>
</Parameters>
</Function>
<Function column="12" file="/Users/jp/Projects/SwiftyJSON/Source/SwiftyJSON.swift" line="116">
<Name>init(_:)</Name>
<USR>s:FV10SwiftyJSON4JSONcFMS0_FPSs9AnyObject_S0_</USR>
<Declaration>public init(_ object: AnyObject)</Declaration>
<Discussion>
<Para>All objects are NSString, NSNumber, NSArray, NSDictionary, or NSNullAll dictionary keys are NSStringsNSNumbers are not NaN or infinity</Para>
<Para>In swift - String as NSString - Bool, Int, Float, Double... as NSNumber - Array&lt;AnyObject&gt; as NSArray - Dictionary&lt;String, AnyObject&gt; as NSDictionary with NSString keys</Para>
</Discussion>
<Parameters>
<Parameter>
<Name>object</Name>
<Direction isExplicit="0">in</Direction>
<Discussion>
<Para>The object must have the following properties:</Para>
</Discussion>
</Parameter>
</Parameters>
</Function>
<Other column="9" file="/Users/jp/Projects/SwiftyJSON/Source/SwiftyJSON.swift" line="130">
<Name>isEmpty</Name>
<USR>s:vV10SwiftyJSON4JSON7isEmptySb</USR>
<Declaration>var isEmpty: Bool { get }</Declaration>
<Abstract>
<Para>`true` if and only if self's type is `.Array` or `.Dictionary` and it is empty</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/SwiftyJSON/Source/SwiftyJSON.swift" line="144">
<Name>count</Name>
<USR>s:vV10SwiftyJSON4JSON5countSi</USR>
<Declaration>public var count: Int { get }</Declaration>
<Abstract>
<Para>`count` value if self's type is `.Array` or `.Dictionary` otherwise is `0`</Para>
</Abstract>
</Other>
<Function column="17" file="/Users/jp/Projects/SwiftyJSON/Source/SwiftyJSON.swift" line="159">
<Name>generate()</Name>
<USR>s:FV10SwiftyJSON4JSON8generateFS0_FT_GVSs11GeneratorOfTSSS0___</USR>
<Declaration>public func generate() -&gt; GeneratorOf&lt;(String, JSON)&gt;</Declaration>
<Discussion>
<Para>If self's type is .Array return GeneratorOf&lt;(index, JSON(element))&gt; otherwise return `nil`If self's type is .Dictionary return GeneratorOf&lt;(index, JSON(element))&gt; otherwise return `nil`</Para>
</Discussion>
</Function>
<Other column="12" file="/Users/jp/Projects/SwiftyJSON/Source/SwiftyJSON.swift" line="196">
<Name>subscript(_:)</Name>
<USR>s:sV10SwiftyJSON4JSON9subscriptFSiS0_</USR>
<Declaration>public subscript (idx: Int) -&gt; JSON { get set }</Declaration>
<Abstract>
<Para>If self is .Sequence return the array[index]'s json else return .Null with error</Para>
</Abstract>
</Other>
<Other column="12" file="/Users/jp/Projects/SwiftyJSON/Source/SwiftyJSON.swift" line="225">
<Name>subscript(_:)</Name>
<USR>s:sV10SwiftyJSON4JSON9subscriptFSSS0_</USR>
<Declaration>public subscript (key: String) -&gt; JSON { get set }</Declaration>
<Abstract>
<Para>If self is .Sequence return the dictionary[key]'s JSON else return .Null with error</Para>
</Abstract>
</Other>
</jazzy>
@jpsim
Copy link
Author

jpsim commented Oct 14, 2014

These were generated by running the following commands in the root of the respective repo's:

  1. Alamofire: SourceKitten -project Alamofire.xcodeproj
  2. SwiftyJSON: SourceKitten -project SwiftyJSON.xcodeproj
  3. Dollar.Dollar: SourceKitten -workspace Dollar.xcworkspace -scheme Dollar
  4. Dollar.Cent: SourceKitten -workspace Dollar.xcworkspace -scheme Cent
  5. QueryKit: SourceKitten

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment