/
JuliaCall.html
249 lines (200 loc) · 10.7 KB
/
JuliaCall.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>JuliaCall: Seamless Integration Between R and Julia. — JuliaCall • JuliaCall</title>
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<meta property="og:title" content="JuliaCall: Seamless Integration Between R and Julia. — JuliaCall" />
<meta property="og:description" content="JuliaCall provides you with functions to call Julia functions and
to use Julia packages as easy as possible." />
<meta name="twitter:card" content="summary" />
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container template-reference-topic">
<header>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">JuliaCall</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.16.6</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fa fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="../articles/JuliaCall_in_Jupyter_R_Notebook.html">JuliaCall in Jupyter R Notebook</a>
</li>
<li>
<a href="../articles/Julia_in_RMarkdown.html">Julia in RMarkdown</a>
</li>
<li>
<a href="../articles/mandelbrot.html">Improve R's Performance using JuliaCall with Mandelbrot Set Example</a>
</li>
</ul>
</li>
<li>
<a href="../news/index.html">Changelog</a>
</li>
</ul>
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/Non-Contradiction/JuliaCall">
<span class="fa fa-github fa-lg"></span>
</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>JuliaCall: Seamless Integration Between R and Julia.</h1>
<small class="dont-index">Source: <a href='https://github.com/Non-Contradiction/JuliaCall/blob/master/R/JuliaCall.R'><code>R/JuliaCall.R</code></a></small>
<div class="hidden name"><code>JuliaCall.Rd</code></div>
</div>
<div class="ref-description">
<p>JuliaCall provides you with functions to call Julia functions and
to use Julia packages as easy as possible.</p>
</div>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
<pre class="examples"><div class='input'>
</div><div class='input'> <span class='co'>## The examples are quite time consuming</span>
<span class='co'>## Do initiation for JuliaCall</span>
<span class='no'>julia</span> <span class='kw'><-</span> <span class='fu'><a href='julia_setup.html'>julia_setup</a></span>()</div><div class='output co'>#> <span class='message'>Julia version 1.0.3 at location /Applications/Julia-1.0.app/Contents/Resources/julia/bin will be used.</span></div><div class='output co'>#> <span class='message'>Loading setup script for JuliaCall...</span></div><div class='output co'>#> <span class='message'>Finish loading setup script for JuliaCall.</span></div><div class='input'>
<span class='co'>## Different ways for calculating `sqrt(2)`</span>
<span class='co'># julia$command("a = sqrt(2)"); julia$eval("a")</span>
<span class='fu'><a href='julia_command.html'>julia_command</a></span>(<span class='st'>"a = sqrt(2)"</span>); <span class='fu'><a href='julia_eval.html'>julia_eval</a></span>(<span class='st'>"a"</span>)</div><div class='output co'>#> 1.4142135623730951
#> </div><div class='output co'>#> [1] 1.414214</div><div class='input'>
<span class='co'># julia$eval("sqrt(2)")</span>
<span class='fu'><a href='julia_eval.html'>julia_eval</a></span>(<span class='st'>"sqrt(2)"</span>)</div><div class='output co'>#> [1] 1.414214</div><div class='input'>
<span class='co'># julia$call("sqrt", 2)</span>
<span class='fu'><a href='call.html'>julia_call</a></span>(<span class='st'>"sqrt"</span>, <span class='fl'>2</span>)</div><div class='output co'>#> [1] 1.414214</div><div class='input'>
<span class='co'># julia$eval("sqrt")(2)</span>
<span class='fu'><a href='julia_eval.html'>julia_eval</a></span>(<span class='st'>"sqrt"</span>)(<span class='fl'>2</span>)</div><div class='output co'>#> [1] 1.414214</div><div class='input'>
<span class='co'>## You can use `julia_exists` as `exists` in R to test</span>
<span class='co'>## whether a function or name exists in Julia or not</span>
<span class='co'># julia$exists("sqrt")</span>
<span class='fu'><a href='julia_exists.html'>julia_exists</a></span>(<span class='st'>"sqrt"</span>)</div><div class='output co'>#> [1] TRUE</div><div class='input'>
<span class='co'>## You can use `julia$help` to get help for Julia functions</span>
<span class='co'># julia$help("sqrt")</span>
<span class='fu'><a href='julia_help.html'>julia_help</a></span>(<span class='st'>"sqrt"</span>)</div><div class='output co'>#> ```
#> sqrt(x)
#> ```
#>
#> Return $\sqrt{x}$. Throws [`DomainError`](@ref) for negative [`Real`](@ref) arguments. Use complex negative arguments instead. The prefix operator `√` is equivalent to `sqrt`.
#>
#> # Examples
#>
#> ```jldoctest; filter = r"Stacktrace:(\n \[[0-9]+\].*)*"
#> julia> sqrt(big(81))
#> 9.0
#>
#> julia> sqrt(big(-81))
#> ERROR: DomainError with -8.1e+01:
#> NaN result for non-NaN input.
#> Stacktrace:
#> [1] sqrt(::BigFloat) at ./mpfr.jl:501
#> [...]
#>
#> julia> sqrt(big(complex(-81)))
#> 0.0 + 9.0im
#> ```
#>
#> ```
#> sqrt(A::AbstractMatrix)
#> ```
#>
#> If `A` has no negative real eigenvalues, compute the principal matrix square root of `A`, that is the unique matrix $X$ with eigenvalues having positive real part such that $X^2 = A$. Otherwise, a nonprincipal square root is returned.
#>
#> If `A` is symmetric or Hermitian, its eigendecomposition ([`eigen`](@ref)) is used to compute the square root. Otherwise, the square root is determined by means of the Björck-Hammarling method [^BH83], which computes the complex Schur form ([`schur`](@ref)) and then the complex square root of the triangular factor.
#>
#> [^BH83]: Åke Björck and Sven Hammarling, "A Schur method for the square root of a matrix", Linear Algebra and its Applications, 52-53, 1983, 127-140. [doi:10.1016/0024-3795(83)80010-X](https://doi.org/10.1016/0024-3795(83)80010-X)
#>
#> # Examples
#>
#> ```jldoctest
#> julia> A = [4 0; 0 4]
#> 2×2 Array{Int64,2}:
#> 4 0
#> 0 4
#>
#> julia> sqrt(A)
#> 2×2 Array{Float64,2}:
#> 2.0 0.0
#> 0.0 2.0
#> ```</div><div class='input'>
<span class='co'>## You can install and use Julia packages through JuliaCall</span>
<span class='co'># julia$install_package("Optim")</span>
<span class='fu'><a href='julia_package.html'>julia_install_package</a></span>(<span class='st'>"Optim"</span>)
<span class='co'># julia$install_package_if_needed("Optim")</span>
<span class='fu'><a href='julia_package.html'>julia_install_package_if_needed</a></span>(<span class='st'>"Optim"</span>)
<span class='co'># julia$installed_package("Optim")</span>
<span class='fu'><a href='julia_package.html'>julia_installed_package</a></span>(<span class='st'>"Optim"</span>)</div><div class='output co'>#> [1] "0.18.1"</div><div class='input'>
<span class='co'># julia$library("Optim")</span>
<span class='fu'><a href='julia_package.html'>julia_library</a></span>(<span class='st'>"Optim"</span>)</div><div class='input'>
</div></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
<ul class="nav nav-pills nav-stacked">
<li><a href="#examples">Examples</a></li>
</ul>
</div>
</div>
<footer>
<div class="copyright">
<p>Developed by Changcheng Li.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p>
</div>
</footer>
</div>
</body>
</html>