Skip to main content

contexts - How do I create and use Mathematica packages?


I have created a package following the tutorial in Mathematica 8 virtual book. However this tutorial is quite, let's call it, "short". I have a TestPackage.m file:


BeginPackage["TestPackage`"];
TestPackage::usage = "Test package"

Begin["`Private`"]
TestPackage[1] := {1}
(*private functions and stuff*)
Mesg := Print["Private function of TestPackage"]

End[]

TestPackage` f[x_] := Module[{a = 3, b = 3}, Mesg; a x^b]

EndPackage[]

and a file UseTestPackage.nb that uses the package:


ClearAll["Global`*"]
dir = "C:/...and so on"
Get["TestPackage`", Path -> dir]


f[2] (*this should give an output defined in TestPackage.m, but it doesn't*)

$ContextPath

(* {"PacletManager`", "WebServices`", "System`", "Global`"}*)
(*seems it didn't read the m file*)

but nothing happens. No symbols of functions are exported, despite the fact that Get[] doesn't throw an error.


How do I make it work?




Answer



Your specific problem looks like you somehow managed to not load the package properly (did you evaluate Get[...]?). There's also an excess space in your long-form call to f (just before EndPackage[]) that will give you an error.


Although your package will work if you fix the typo, this is not in general a good way to define your function. To see why, try:


<<"path/to/TestPackage.m"
Names["TestPackage`*"]
(* {"a", "a$", "b", "b$", "f", "Mesg", "TestPackage", "x"} *)

Your private symbols are now polluting your package's context.




In general, the way to do this is to put all your definitions and auxiliary symbols in the private context and "expose" only those that you need publicly. All that needs to be done for this is to just have the symbol in some definition before beginning the private context and this is typically done with a usage definition. Here's a modification of your example above:



BeginPackage["TestPackage`"];
f::usage = "My function"

Begin["`Private`"]
Mesg := Print["Private function of TestPackage"]
f[x_] := Module[{a = 3, b = 3}, Mesg; a x^b]
End[]

EndPackage[]


Now, in a notebook, evaluate:


<< "path/to/TestPackage.m"
f[2]
(* Private function of TestPackage
24 *)

which gives you your desired result.


Note how I exposed only f and not Mesg, because the latter (as an example) is not essential to the outside world. You can see that indeed only this is "known" to the outside world:


Names["TestPackage`*"]
(* {f} *)


However, all symbols can always be accessed with their full context path. For example, you can access Mesg as:


TestPackage`Private`Mesg
(* Private function of TestPackage *)

Comments

Popular posts from this blog

plotting - How to draw lines between specified dots on ListPlot?

I would like to create a plot where I have unconnected dots and some connected. So far, I have figured out how to draw the dots. My code is the following: ListPlot[{{1, 1}, {2, 2}, {3, 3}, {4, 4}, {1, 4}, {2, 5}, {3, 6}, {4, 7}, {1, 7}, {2, 8}, {3, 9}, {4, 10}, {1, 10}, {2, 11}, {3, 12}, {4,13}, {2.5, 7}}, Ticks -> {{1, 2, 3, 4}, None}, AxesStyle -> Thin, TicksStyle -> Directive[Black, Bold, 12], Mesh -> Full] I have thought using ListLinePlot command, but I don't know how to specify to the command to draw only selected lines between the dots. Do have any suggestions/hints on how to do that? Thank you. Answer One possibility would be to use Epilog with Line : ListPlot[ {{1, 1}, {2, 2}, {3, 3}, {4, 4}, {1, 4}, {2, 5}, {3, 6}, {4, 7}, {1, 7}, {2, 8}, {3, 9}, {4, 10}, {1, 10}, {2, 11}, {3, 12}, {4, 13}, {2.5, 7}}, Ticks -> {{1, 2, 3, 4}, None}, AxesStyle -> Thin, TicksStyle -> Directive[Black, Bold, 12], Mesh -> Full, Epilog -> { Line[ ...

list manipulation - Selecting multiple columns from a matrix?

Sample data: data = { {{2013, 1, 1}, 24.13, 167.67, 231.82}, {{2013, 1, 2}, 32.15, 170.92, 225.99}, {{2013, 1, 3}, 35.43, 172.68, 221.67}, {{2013, 1, 4}, 36.73, 173.05, 218.32}, {{2013, 1, 5}, 58.19, 165.96, 197.05}, {{2013, 1, 6}, 69.99, 163.50, 187.52}, {{2013, 1, 7}, 71.37, 154.21, 175.58}, {{2013, 1, 8}, 72.51, 149.66, 163.25}}; I want a DateListPlot with three graphs, so for a matrix formed by columns 1 and 2, one for columns 1 and 3, and 1 for columns 1 and 4. At the moment I'm using this code: data2 = Transpose[{data[[All, 1]], data[[All, 2]]}]; data3 = Transpose[{data[[All, 1]], data[[All, 3]]}]; data4 = Transpose[{data[[All, 1]], data[[All, 4]]}]; DateListPlot[{data2, data3, data4}, Joined -> True, Filling -> {3 -> {1}}] but I have a hunch that this can be done more efficiently. I don't like the Transpose s in particular. Any ideas? edit (for extra credit) What if I need to multiply the second column by 2, which in my solution is simp...

calculus and analysis - Integral of the Sinc product

Let us consider the following integral $$ B_n = \int_0^\infty \prod_{k=1,3,5,\dots}^n\frac{\sin (x/k)}{x/k}dx $$ By definition, Sinc[x] == Sin[x]/x , therefore B[n_?OddQ] := Integrate[Product[Sinc[x/k], {k, 1, n, 2}], {x, 0, Infinity}] B /@ Range[1, 13, 2] {Pi/2, Pi/2, Pi/2, Pi/2, Pi/2, Pi/2, Pi/2} OK, everything is fine. But... B[15] 467807924713440738696537864469 Pi/935615849440640907310521750000 What's going on? Answer As Eckhard wrote in comments B[n] is the n-th Borwein integral . (The letter B was not accidental :) ) This funny properties of Borwein integrals is related to the Fourier transform of Sinc function FourierTransform[Sinc[x], x, k] 1/2 Sqrt[Pi/2] (Sign[1 - k] + Sign[1 + k]) Plot[%, {k, -2, 2}, Filling -> 0] which is the box function. The result is $\pi/2$ while the sum $$ 1/3+1/5+\dots+1/n $$ B_n = \frac{\pi}{2} - \pi \bigg(\sum_{k=3,5,\ldots}^n\frac{1}{k} -1\biggr)^\frac{n-1}{2}\prod_{k=3,5,\dots}^n\frac{k}{k-1}. $$ For $n=15$ it is equal to $$ \frac{46780...