My friend Bevan has linked to the tools he referenced in his “Towards Maintainability” talk at the Wellington .NET users group recently.

I thought I’d add the equivalents from the perspective of an Eclipse-using Java developer…

Definr.com

Definr.com isn’t specific to a single programming language.

I simply type things into Google Chrome’s Omnibar.

FxCop & Gendarme

FindBugs

PMD

Visual Studio Class Diagrams

Perhaps AgileJ though I do not use it.

Snippets

Snippets in Eclipse

Creating extensions to snippets

StyleCop

Checkstyle

NAnt

Ant

Maven 2

NUnit

junit

TestDriven.Net

junit is integrated into all IDEs

Sandcastle

Perhaps Doxia?

TeamCity

TeamCity supports java

CruiseControl

Continuum

Hudson

Gump

ReSharper

Mylyn is probably the closest productivity adding, IDE-changing example.

Here are some improvements to JDT Project in Galileo that I personally find useful:

1. Support for {@inheritDoc} in the javadoc popups.
   • This is encourages its use, which in turn encourages documenting why a method has been overridden, or what’s so special about this particular implementation, without having to repeat the purpose of the method itself.
2. Warnings when a method overrides a synchronized method, but isn’t synchronized itself.
   • It’s hard enough as it is to ensure you get the intended multi-threaded behaviour. This change can help prevent an error that while not very common, can be very hard to spot.
3. When auto-reformatting an entire class, I can keep the line breaks that I’ve added.
   • This caters for where the formatting rules are too general, and are not aware that I’d find some things much clearer if split into multiple lines in very specific places.
4. Constructor completion has been made more useful, by offering more appropriate suggestions.
   • I also often save myself some typing by writing the right hand side of the assignment, then using a quick assist to assign the result to a new variable.
5. By holding down Ctrl, and hovering on a method, I can chose whether to jump to the declaration, or the implementation.
   • I still find this method of navigation difficult though, preferring to keep my hands on the keyboard, navigating to the method call, pressing Ctrl-T, and choosing which implementing or declaring class I wish to view. (That’s not a new feature.)
   • What I’d like is a companion for F3’s mapping of “Go To Declaration” that with a single key press I can “Go To Implementation”. However I can’t find that command in the key binding preferences page.

My friend Bevan points out a post on NUnit Best Practices by Scott White, and asks whether we agree with them.

Most of my coding these days is in java, so some of Scott’s best practices need altering to my situation, e.g. junit.jar instead of nunit.framework.dll.

For reference, I disagree to varying extents with #1, #2, #3, and #5, and agree with #4, #6, and #7.

However I believe that best practices are often relative to the situation you find yourself in. That situation includes which IDE you are using, and how best to use it, how large your team is, how complex your application is, etc.

I also think that it is an excellent idea to consider which practices consciously or unconsciously drive your coding practice, and whether any of them could be improved. Scott himself says that best practices change over time, and his blog seems to have a long running theme of identifying some of these changes. I commend him for identifying and documenting what he does, providing advice for others to consider, and asking for feedback.

Here are my reasons for disagreeing with some of his NUnit best practices, from my junit in eclipse standpoint:

#1

I primarily disagree since all too often the tests are not distributed with the code being tested. When dealing with some-one else’s code, I don’t have their test cases, so if I have problems with their code, I can’t simply find out whether their test cases still work in my environment, nor whether I’m using parts of their code which are not covered by their tests.

Secondly, I disagree with “don’t be lazy”. We should all be striving to have our best practices also be the easiest things to do.

#2 & #3

These are things that should be integrated into your IDE and dependency management tools. They appear to be workarounds for poor visual studio defaults when you wish to use NUnit to test your code.

#5

I prefer the idea of starting by writing test cases in a style that documents what you want to achieve. That then drives what methods you need, and perhaps how they should be collected into various interfaces. I refer to this as an idea since I’m not particularly disciplined in developing in this way.

Overall though, I’d say that I agree with Scott in that solid unit testing using a tool like NUnit is best practice.

I’ve found some interesting mathematical concepts through researching my ideas presented in my previous blog posts on a scheme for representing numbers using Basic Primes, and drawing that representation as Boxy Numbers.

There is a function named pi, (written as the greek symbol), but pi isn’t used in reference to circles’ diameters and circumferences, but is instead (as far as I can tell) P. I. standing for prime index. pi(x) is equal to the number of primes equal to or less than x.

By altering my representation slightly so that the number one is represented as a single box:

So that two is the first prime, so two is a box with the representation of one inside it (which is how I previously drew three).

Then the representation of any number n is drawn by producing n’s prime factors, f₀ to f_k and each factor f_i is drawn as a box with the representation of pi(f_i) inside it.

To make the representation slightly more aesthetic, you can fill in all the gaps with the representation of one. This is because everything is multiplied, and you can of course multiply by one as many times as you like without altering the product. Multiplication is also commutative, so the boxes may be rearranged to give a pleasant looking number, so long as the number of boxes within any box stays the same.

Multiplication is simply a case of drawing both sets of boxes for the numbers being multiplied.

Division and rational numbers are probably best drawn with a numerator over a divisor separated by a line. Common factors are easily identified and removed.

By contrast, addition and subtraction are intensely difficult.

Here’s a walk-through of representing your birthday as a bunch of boxes:

You could draw the number for the day, month and year individually, but you’ll probably end up with more a more interesting drawing if you start with one large number n = YYYYMMDD. So for my birthday, 8th September 1972, n=19720908

The first step is to produce the prime factors. There are lots of ways of doing this. The easiest way if you are reading this online is to use an online tool. The one from Maths Is Fun says my prime factors are 6763 x 3 x 3 x 3 x 3 x 3 x 3 x 2 x 2.

So I need nine boxes, containing the representation of pi of each factor.

Though boxes can be arranged in any way you like, in order to demonstrate the technique I’ll stay consistent, showing these vertically, as otherwise by the end of the post I’ll be running out of room. Web pages have a fixed width, but can be infinitely long:

There’s an online calculator of pi(n) too here.

It reports that there are:

871 primes less than or equal to 6763

2 primes less than or equal to 3

1 prime less than or equal to 2

So our boxes need to be:

We repeat the process for each of these numbers, drawing a box for each prime factor, and writing pi(factor) in each box.

The prime factors of 871 are 67 x 13, so we need two boxes.

2 is prime, so each of the 2s need a single box.

1 has been defined as a box with nothing in it.

pi(67) = 19

pi(13) = 6

pi(2) we’ve previously seen = 1

So our boxes need to be:

Producing prime factors again, 19 is prime, so a single box is needed. 6s prime factors are 3 x 2, so two boxes needed

We’ll replace 1s as before.

So we’ve got:

Evaluating the pi functions gives:

Factorising gives:

Evaluating the pi functions gives:

Replacing the last 1s with their representation of an empty box gives the final representation:

Rearranging this into a pleasing arrangement gives

The Eclipse Ganymede release is only a few weeks away. As a long time eclipse user, inquisitive, early adopter, I’ve been trying the milestone and release candidates of the java developer tools components. (Ganymede is a coordinated release of an enormous number of eclipse projects. Several packages are available here.)

The list of new features is no longer as easy to find, since it was linked to from the download page for the milestone releases, and since the releases are now release candidates, there are no new features.

These will no doubt be combined into a single what’s new page for the final release, but until then, the lists for each milestone release are well worth a read: M1 M2 M3 M4 M5 M6 M7

Update: As expected, the release of 3.4 is accompanied by a new New and Noteworthy page. What’s also worth reviewing is the feature comparison page for the various Ganymede packages.

My personal favourite dozen new features:

1. System Proxy Settings – One less place to change those settings when I plug the laptop in somewhere new.
2. Default console and file encoding – I develop on Windows for Linux.
3. Shearing – I love the pun.
4. The improved error log view, and the Plug-in registry view enhancements – these will help when trying out misbehaving plug-ins.
5. Line support in overview ruler – much faster navigation.
6. Runnable JAR export wizard – no more searching for and installing third party plug-ins to do this simple thing.
7. Different highlighting for read and write occurrences of the selected or searched for element – this is fantastic.
8. Direct interaction with text hovers – less hand movement is good. Being able to click through to other javadocs is fantastic.
9. Breadcrumb navigation – this is a quite good compromise between ease of use and screen real estate.
10. Support for external class folders – I haven’t used this yet, but can think of some past experiences where it would have been useful.
11. Java compiler on multi-CPU machines – parallelisation is how we go faster these days.
12. Quick Assist becomes even more helpful.

Eclipse’s quick assist feature saves a huge amount of work. There’s no need to go looking through menus and dialogs to find the right place to activate the thing you want to do right now, you simply hit Ctrl-1 and what you want to do is invariably in the short list that immediately pops up. The “what’s new” pages list these additional assists and fixes:

M1
-    Helps with regular expressions in find/replace
-    Helps correct spelling in CVS commits
M2
-    PDE Quickfix for Java file issues
-    Add @throws or @exception javadoc tag
-    Select a missing method error in the Problems view and Quick Fix
-    Create getter and setters for fields (encapsulate fields)
-    Extract method on expressions
-    Helps with the new SWT Templates
-    Helps with user created templates
M3
-    Code completion helps with casts
-    Complete static members of not yet imported types
M4
-    Ensure source entries found in build.properties are properly accounted for in the plug-in manifest
-    Diagnosis (and removal quick fix) of redundant superinterfaces
-    Improved key binding support
-    Convert to StringBuffer
M5
-    Improved cursor jumping
M6
-    New Javadoc tags to annotate (PDE) API with explicit restrictions
-    Quick fix provided for missing or incorrect @since tags
-    The Java problem hover now offers all available quick fixes
-    Use MessageFormat for string concatenation
-    Extract local variable (without replacing all occurrences)
-    only show templates applicable at the current location
M7
-    Remove invalid use of API Javadoc tags
-    Inserting parameter name also shows guessed arguments
-    Shows gory details of improved text search

I tried out RikReader recently, which is one of the class of feed readers which use Internet Explorer’s (and Vista’s) list of RSS feeds. It has its pro’s and con’s, but the lack of the ability to refresh all feeds was initially a surprise.

It doesn’t need that feature though, since using IE’s feeds, it also uses IE’s feed updating mechanism. I don’t really like IE’s feed updating mechanism, since it is a background task that keeps using my laptop’s resources when it wants to, rather than when I want it to.

Investigating how it updates, I discovered that I can disable the background task, and when I want the feeds updated, I can run:

msfeedssync forcesync

I thought I’d blog about it, since there are currently so few mentions (in English) of this.

I created a shortcut to run that on my Quick Launch bar. Can anyone comment on where to find a pre-installed rss icon?

My previous post “Basic Primes in Scala” ended with some ideas of how to salvage some use out of the algorithm. I mentioned representing the numbers as concentric circles. Playing around with a text editor, I converted some of the numbers to arrangements of concentric squares.

Left to right are the factors, rearrange at will. The vertical arrangement represents the power.

Here are some of the results shown in the previously generated style, and recreated as groups of concentric squares.

2:[]

[]

3:[[]]
 ____
[    ]
[ [] ]
[____]

4:[]([])

[]

[]

5:[[[]]]
 ________
[  ____  ]
[ [    ] ]
[ [ [] ] ]
[ [____] ]
[________]

6:[[]][]
 ____
[    ]
[ [] ]
[____] []

7:[[]([])]
 ____
[    ]
[ [] ]
[    ]
[ [] ]
[____]

8:[]([[]])
 ____
[    ]
[ [] ]
[____]

[]

9:[[]]([])

[]
 ____
[    ]
[ [] ]
[____]

10:[[[]]][]
 ________
[  ____  ]
[ [    ] ]
[ [ [] ] ]
[ [____] ]
[________] []

11:[[[[]]]]
 ____________
[  ________  ]
[ [  ____  ] ]
[ [ [    ] ] ]
[ [ [ [] ] ] ]
[ [ [____] ] ]
[ [________] ]
[____________]

...

293:[[[[[[]]]]][]]
 _______________________
[  ________________     ]
[ [  ____________  ]    ]
[ [ [  ________  ] ]    ]
[ [ [ [  ____  ] ] ]    ]
[ [ [ [ [    ] ] ] ]    ]
[ [ [ [ [ [] ] ] ] ]    ]
[ [ [ [ [____] ] ] ]    ]
[ [ [ [________] ] ]    ]
[ [ [____________] ]    ]
[ [________________] [] ]
[_______________________]

294:[[]([])]([])[[]][]

[]
 ____
[    ]
[ [] ]  ____
[    ] [    ]
[ [] ] [ [] ]
[____] [____] []

295:[[[[]([])]]][[[]]]
 ____________
[  ________  ]
[ [  ____  ] ]
[ [ [    ] ] ]
[ [ [ [] ] ] ]  ________
[ [ [    ] ] ] [  ____  ]
[ [ [ [] ] ] ] [ [    ] ]
[ [ [____] ] ] [ [ [] ] ]
[ [________] ] [ [____] ]
[____________] [________]

296:[[[]][]([])][]([[]])
 ___________   ____
[  ____     ] [    ]
[ [    ] [] ] [ [] ]
[ [ [] ]    ] [____]
[ [____] [] ]
[___________] []

297:[[[[]]]][[]]([[]])
 ____________   ____
[  ________  ] [    ]
[ [  ____  ] ] [ [] ]
[ [ [    ] ] ] [____]
[ [ [ [] ] ] ]  ____
[ [ [____] ] ] [    ]
[ [________] ] [ [] ]
[____________] [____]

298:[[[]([])][[[]]]][]
 ___________________
[  ____   ________  ]
[ [    ] [  ____  ] ]
[ [ [] ] [ [    ] ] ]
[ [    ] [ [ [] ] ] ]
[ [ [] ] [ [____] ] ]
[ [____] [________] ]
[___________________] []

299:[[[]]([])][[[]][]]
 ________
[        ]
[  []    ]  ___________
[  ____  ] [  ____     ]
[ [    ] ] [ [    ]    ]
[ [ [] ] ] [ [ [] ]    ]
[ [____] ] [ [____] [] ]
[________] [___________]

300:[[[]]]([])[[]][]([])

[]
 ________
[  ____  ]
[ [    ] ]  ____
[ [ [] ] ] [    ] []
[ [____] ] [ [] ]
[________] [____] []

One of the IP addresses of this blog: 72.233.2.56:

 ______________________   ____________
[                      ] [  ________  ]
[ []                   ] [ [  ____  ] ]                ____________
[  ________            ] [ [ [    ] ] ]               [  ________  ]
[ [  ____  ]           ] [ [ [ [] ] ] ]  ___________  [ [  ____  ] ]  ____          ____
[ [ [    ] ]  ____     ] [ [ [    ] ] ] [  ____     ] [ [ [    ] ] ] [    ]        [    ]
[ [ [ [] ] ] [    ]    ] [ [ [ [] ] ] ] [ [    ]    ] [ [ [ [] ] ] ] [ [] ]  ____  [ [] ]
[ [ [____] ] [ [] ]    ] [ [ [____] ] ] [ [ [] ]    ] [ [ [____] ] ] [    ] [    ] [____]
[ [________] [____] [] ] [ [________] ] [ [____] [] ] [ [________] ] [ [] ] [ [] ]
[______________________] [____________] [___________] [____________] [____] [____] []

Explanation: The IP 72.233.2.56 = 1223230008

1223230008 = 863 * 59 * 13 * 11 * 7 * 3 * 2^3

863 is the 150th prime. 150 = 5^2 * 3 * 2

59 is the 17th prime. 17 is the 7th prime.

13 is the 6th prime.

I’ve started learning Scala. One way I learn is by reading and experimenting, so I looked for a simple program I could write in the right problem space to make use of language features expressed more succinctly in Scala than in Java.

Desired Application

I chose to implement a weird idea that I had a couple of years ago: Instead of representing natural numbers in base 10, or any other fixed base, record the prime factorisation. Instead of recording how many 1s, 10s, 100s, 1000s, etc. to sum, you can record how many 2s, 3s, 5s, 7s, 11s, 13s, etc. to multiply. (With a special code for 1.) Each prime number is indexed, and referred to by its index, such that, for example the number 288 (base 10) = 3^2 x 2^5, which is 3 (the second prime) to the power of 2 (the first prime), multiplied by 2 (the first prime) to the power of 5 (the third prime). The powers are also converted into their representation within this same system.

Using [x] to refer to the x’th prime, we get 288 (base 10)

= [2] ^ [1] x [1] ^ [3]
= [[1]] ^ [1] x [1] ^ [[2]]
= [[1]] ^ [1] x [1] ^ [[[1]]]

Everything reduces to [1], which I then replace with []. Multiplication signs can be removed, and power signs can be replaced with parenthesis to give a cryptic representation: 288 = [[]]([])[]([[[]]])

A cleaner representation may be to replace 1, with (), meaning “to the power of zero”, but that is not what I did for this silly example.

That covers the basic idea for the program: conversion from simple base 10 numbers into these cryptic character sequences representing the prime factorisation.

Generating A Sequence Of Primes

To start with I looked for a way to calculate primes in Scala. The docs on scala.Stream includes a simple definition of the Sieve of Eratosthenes. I started with something similar, which I found on Scala Kurz:

def sieve(s: Stream[Int]): Stream[Int] =
  Stream.cons(s.head, sieve(s.tail filter (_ % s.head != 0)))
val primes = sieve(Stream.from(2))

This simple algorithm is quite easy to understand, but unfortunately is pretty useless, as it is so resource intensive that without changing any JVM runtime parameters, it can only calculate up to the 1641st prime (or the 3715th prime if using the scala runtime, which starts the jvm with a larger heap) before overflowing the stack.

Generating A Sequence Of Primes Efficiently

The Literate Programs site includes the same implementation in its Sieve of Eratosthenes in Scala page, but the Sieve of Eratosthenes in Haskell includes a more efficient functional implementation that I thought I’d convert to Scala (I don’t know Haskell, but the algorithm is explained well).

The most difficult part of the conversion was trying to decipher what foldr1 was supposed to do. I incorrectly assumed it was the same as Stream.foldRight, which I butchered till I arrived at something that seemed to work (The definition of foldr1 below is probably not equivalent to Haskell’s.):

def merge(xs: Stream[Int] , ys: Stream[Int]): Stream[Int] = {
  if (xs.head < ys.head)
    return Stream.cons(xs.head, merge(xs.tail, ys))
  if (xs.head == ys.head)
    return Stream.cons(xs.head, merge(xs.tail, ys.tail))
  return Stream.cons(ys.head, merge(xs, ys.tail))
}
def diff(xs: Stream[Int], ys: Stream[Int]): Stream[Int] = {
  if (xs.head < ys.head)
    return Stream.cons(xs.head, diff(xs.tail, ys))
  if (xs.head == ys.head) return diff(xs.tail, ys.tail)
  return diff(xs, ys.tail)
}
def f(xs: Stream[Int], ys: => Stream[Int]) =
  Stream.cons(xs.head, merge(xs.tail, ys))
def g(p: Int) = Stream.from(p*p,p*2)
def foldr1(f: (Stream[Int], => Stream[Int]) => Stream[Int])
  (s: Stream[Stream[Int]]): Stream[Int] =
  if (s.isEmpty) Stream.empty
  else f(s.head, foldr1(f)(s.tail))
val primes: Stream[Int] =
  Stream.fromIterator((2::3::5::Nil).elements).append(
      diff(Stream.from(7,2), nonprimes))
val nonprimes = foldr1(f)(primes.tail map g)

Now I can calculate up to the 18707th prime, an order of magnitude more that the simple algorithm, in an order of magnitude more lines of code.

Comments in Jorge Ortiz post Fun with Project Euler and Scala also mention the poor resource utilisation of the two-line sieve, and code is supplied for providing a stream of primes using java’s BigInteger.nextProbablePrime(). I’ll leave that for now though, and get back on track…

Determining Prime Factorisation

Next I needed indexed prime factors:

// Prime Factor Tuple: Prime, Power, Index
type Factors = List[(Int, Int, Int)];
def primeFactorsRecurse(i: Int, factors: Factors,
    morePrimes: Stream[Int], index: Int): Factors = {
  if (i == 1) return factors;
  if (i % morePrimes.head == 0) {
    if ((factors != Nil) && (morePrimes.head == factors.head._1)) {
      return primeFactorsRecurse(i / morePrimes.head,
          (morePrimes.head, factors.head._2 + 1, index) ::
          factors.tail,
          morePrimes, index);
    } else {
      return primeFactorsRecurse(i / morePrimes.head,
          (morePrimes.head, 1, index) :: factors,
          morePrimes, index);
    }
  }
  return primeFactorsRecurse(
      i, factors, morePrimes drop 1, index + 1);
}

def primeFactors(i: Int): Factors = {
  if (i == 1) return (1,1,0) :: Nil;
  primeFactorsRecurse(i, Nil, primes, 1);
}

Printing The Numbers

All that is needed now is the code to print the numbers using the unusual representation described above:

def printPrimeFactors(factors: Factors): Unit = {
  factors match{
    case (prime: Int, power: Int, index: Int) :: morefactors =>  {
      if (index > 0) printPrimeFactors("[", index, "]")
      if (power > 1) printPrimeFactors("(", power, ")")
      printPrimeFactors(morefactors)
    }
    case Nil => ();
  }
}

def printPrimeFactors(pre: String, i: Int, post: String): Unit = {
  print(pre)
  printPrimeFactors(primeFactors(i))
  print(post)
}

(1 to 300) foreach {i: Int => printPrimeFactors(i + ":",i,"\n")}

Summary

I was able to create an application in Scala to do what I wanted, while making use of a number of Scala language features.

I’ll welcome corrections, and comments regarding the Scala code, such as how I can create a infix Stream.cons operator to make my code less verbose, or ways to automatically switch to BigInts if the range of Int is surpassed.

I’d also be extremely interested in anyone can think of a use for this representation of natural numbers. The same ideas can be converted into graphical symbols, e.g. using differently sized concentric circles instead of [[[]]], or tracing a path to give a particular “primal squiggle” that uniquely represents a number, (such as an IP address). The order of factors doesn’t matter, so that provides scope to position graphical representations of them in artistically pleasing arrangements.

This is my first post. It was created automatically by WordPress, but I’ve edited it.

When starting to edit it, I was trying to decide whether to change the title. WordPress had given it the title “Hello world!”, which I had used as the title for the first entry in my son’s blog, announcing his birth. I think that blog post deserved such a title, but this one doesn’t. Such a title doesn’t convey any details about the contents of what I’m writing here. No one is going to have their curiosity piqued by a WordPress blog post titled “Hello world!”. So I changed it.