What's poppin' 💥 gang 👨🏫, Cameron is coming in **_HOT_**🔥🚒🧯🧨 with a class 🏫 about packages 📦 and stuff 🙌. He wrote this whole notebook 📓, but I've snuck this little bit of text✍🏼 in right under ⬇️ his nose 👃🏼!
Welcome back to class! Because there was no assigned homework, there are no assigned problems to present. So, solutions to any Euler problems completed over the past week are welcome to presented now. These include:
Often in Julia, you'll need to read in files to have data to work with, and there's a number of methods we can use to accomplish this. First, let's create a file and put some information in it.
# Open a file for writing and write to it
# Close the file so that changes are actually applied
Now, open the file again with another handler to read from it.
# opening the file with open
# calling read to read from the file
In fact, we can actually shortcut this process just by calling read() directly. read() understands we're talking about a file path and opens it for us.
# using read to read the file directly
# using readlines to read in lines as an array
# using readline to read one at a time
# using eachline to create an interable
do syntax¶Julia has a special syntax using a do block if you want to use a function as your first argument. Take the map function as an example, which takes an Array and a function to apply on that array.
a = [1, 2, 3]
# Applyng map function normally
# Applying map function with do syntax
This syntax actually works for any function with a Function as the first argument. Let's create a function below and use the do function to figure out what f(5) is.
function runSomeMath(f::Function)
println("Figuring out what f(5) is!")
return f(5)
end
runSomeMath() do x
# math function goes here
end
open() and read() with a do block¶The convenience of this method is that the file is automatically opened and closed for us within the block, giving us a scoped area to deal with the file and close it once we're done. This is similar to opening a file with a with statement in Python.
# opening a file for writing with do
# reading a file with do
Random module¶because it might come in handy at some point to you. One thing we can do with Random is generate random lists of numbers using the rand(type or set[, dims]) function.
using Random
# generating random decimals
# generating a random list
# generating a random value in a ranges
Another thing we can do with the Random module is shuffle lists.
ajr = ["Adam", "Jack", "Ryan"] # or Aaron, Johnson, Rodger (no)
# shuffling a list
# shuffling a range
To write log messages, we're going to use the Logging module. Julia describes the Logging module as:
The
Loggingmodule provides a way to record the history and progress of a computation as a log of events.
There's a couple different logging "levels" as defined by Julia that explain how serious a problem is, or what the purpose of the log message is:
The log level is a broad category for the message that is used for early filtering. There are several standard levels of type
LogLevel; user-defined levels are also possible. Each is distinct in purpose:
Debugis information intended for the developer of the program. These events are disabled by default.Infois for general information to the user. Think of it as an alternative to usingprintlndirectly.Warnmeans something is wrong and action is likely required but that for now the program is still working.Errormeans something is wrong and it is unlikely to be recovered, at least by this part of the code. Often this log-level is unneeded as throwing an exception can convey all the required information.
For your purposes, you're probably going to want to use @info most of the time, or maybe @warn or @error if you wanted to catch someone's attention.
using Logging
# Logging with @info
# Displaying variables and named parameters
# Logging with @warn and @error
Before we get to tests, there's one quick and dirty way in Julia to have code throw an error if something fails, which is @assert.
# using @assert if true
# what happens when @assert is false
To write and run tests, we're going to use the Test module. Julia describes the Test module as:
The
Testmodule provides simple unit testing functionality. Unit testing is a way to see if your code is correct by checking that the results are what you expect. It can be helpful to ensure your code still works after you make changes, and can be used when developing as a way of specifying the behaviors your code should have when complete.
First, let's import the Test module.
using Test
The most basic thing we can do with the test module is check whether a statement is true or not by using the @test macro.
# write @test
We can also check whether a function under a set of conditions throws a specific error using @test_throws Error function().
# write @test_throws
We can check that a function logs a certain message using a certain log level with @test_logs (:level, "message") function().
function iLog(variable)
@info "You gave me $variable"
end
# write @test_logs
Now, let's create a function to check who won a game of TicTacToe, using a 3×3 matrix to represent a game. 1s will represent one player while 2s will represent the other. 0s represent unplayed spaces.
using LinearAlgebra
function ticTacToeCheck(board::Array{Int,2})
size(board) == (3,3) || throw(DimensionMismatch("Board size mismatch"))
winSeqs = vcat([board[n, :] for n in 1:3], [board[:, n] for n in 1:3]) # check rows and columns
winSeqs = vcat(winSeqs, [diag(board)], [diag(board[:, end:-1:1])]) # add diagonals
if [1,1,1] in winSeqs
return 1
elseif [2,2,2] in winSeqs
return 2
else
return 0
end
end
Now, we're going to use the @testset functionality to check our ticTacToe checker to see if it works.
@testset "Tic Tac Toe" begin
win1 = [1 0 2
1 2 0
1 0 0]
win2 = [1 1 2
1 2 0
2 0 0]
nowin = [1 1 2
2 2 1
1 2 1]
breaks = [1 2 1
2 1 2]
# write tests here
end
While the previous modules may help you with general Julia development, the Primes module will specifically be useful for solving Euler problems. Many Euler problems ask you to calculate values from primes and you may want to check whether certain problems are primes.
To generate primes, we can use the primes(hi) function:
using Primes
# generating primes
If we want to check whether a number is prime, we can use the isprime(num) method. We can also factor numbers using factor(num), which returns a Factorization type that functions a little like a dictionary.
# checking isprime
# checking factor
Sometimes it's useful to know the totient of a number, $\phi(n)$, which is the number of positve integers less than $n$ that are relatively prime to $n$. Primes can do that for us.
# passing factorization
# calling totient directly
This week, we'll be giving you some homework based on the packages we taught you this week.
https://projecteuler.net/problem=22
Using names.txt (right click and 'Save Link/Target As...'), a 46K text file containing over five-thousand first names, begin by sorting it into alphabetical order. Then working out the alphabetical value for each name, multiply this value by its alphabetical position in the list to obtain a name score.
For example, when the list is sorted into alphabetical order, COLIN, which is worth 3 + 15 + 12 + 9 + 14 = 53, is the 938th name in the list. So, COLIN would obtain a score of 938 × 53 = 49714.
What is the total of all the name scores in the file?
Hint: make use of read(), strip(), and map() or the broadcast operator
The nth term of the sequence of triangle numbers is given by, tn = ½n(n+1); so the first ten triangle numbers are:
1, 3, 6, 10, 15, 21, 28, 36, 45, 55, ...
By converting each letter in a word to a number corresponding to its alphabetical position and adding these values we form a word value. For example, the word value for SKY is 19 + 11 + 25 = 55 = t10. If the word value is a triangle number then we shall call the word a triangle word.
Using words.txt (right click and 'Save Link/Target As...'), a 16K text file containing nearly two-thousand common English words, how many are triangle words?
https://projecteuler.net/problem=10
The sum of the primes below 10 is 2 + 3 + 5 + 7 = 17.
Find the sum of all the primes below two million.
_With the Primes package, this one is pretty easy. For extra credit, build your own prime generator. Here is one good method._
For this exercise, you're going to provided with a 2D minesweeper board (a 2D matrix) of any given dimensions filled with trues and falses, where trues are mines and falses are empty space. It's your job to generate a minesweeper board from this matrix, replacing the trues with the character 'X' to signify mines, and replacing the falses with the number of nearby mines. A mine is nearby to a space if it is contained in the $3\times 3$ square around the space.
Your goal is to pass the @testset beneath the function below. Once you have done so, add another couple tests of your choosing with gameboards of your choice.
using Test
function generateMineBoard(board::Array{Bool, 2})::Array{Any, 2}
mineBoard = Array{Any, 2}(undef, size(board))
# fill in mineBoard with your code here
end
@testset "Minesweeper Tests" begin
X = 'X'
input = [0 0 0 0 0 0
0 1 0 0 0 0
1 0 0 0 1 0
1 1 0 1 0 0]
expected = [1 1 1 0 0 0
2 X 1 1 1 1
X 4 3 2 X 1
X X 2 X 2 1]
@test generateMineBoard(convert(Array{Bool,2}, input)) == expected
input2 = [0 0 0 0 0 0 0 0 1 0
0 0 0 1 0 1 0 0 0 0
0 0 0 0 1 0 0 0 0 0
1 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 1 0 0 0 1 0
0 0 1 0 1 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 1 0 0 0 0]
expected2 = [0 0 1 1 2 1 1 1 X 1
0 0 1 X 3 X 1 1 1 1
1 1 1 2 X 2 1 0 0 0
X 1 0 1 1 1 0 0 0 0
1 1 0 1 1 1 0 1 1 1
0 1 1 3 X 2 0 1 X 1
0 1 X 3 X 2 0 1 1 1
0 1 1 2 2 2 1 0 0 0
0 0 0 0 1 X 1 0 0 0]
@test generateMineBoard(convert(Array{Bool, 2}, input2)) == expected2
@test generateMineBoard(convert(Array{Bool, 2}, [0 0 0; 1 1 1; 0 0 0])) == [2 3 2; X X X; 2 3 2]
@test generateMineBoard(convert(Array{Bool, 2}, [1 0; 0 0; 0 1])) == [X 1; 2 2; 1 X]
@test generateMineBoard(ones(Bool, (5,5))) == fill('X', (5,5))
@test generateMineBoard(zeros(Bool, (5,5))) == zeros(Bool, (5,5))
end