3 ms·
> I'm going to assume you're not deliberately trying to misunderstand him for the sake of a hot take, because, that would be pretty lame. I'll admit, my exampl
by klyrs 7y ago
> I'm going to assume you're not deliberately trying to misunderstand him for the sake of a hot take, because, that would be pretty lame.
I'll admit, my example was overwrought with comedic intent, but I stand firm on this issue. Use a magic number twice? Yeah, go ahead and put that numeric literal somewhere convenient (but you still have a numeric literal) to the consumers of it and easy to find by your readers (not a top-level magic_numbers.h)
I'm a mathematician. The fear of numbers in code is an affront to the domain that I work in. YMMV. I put a lot of work into documenting my code, but for the love of pete, 2 is not a magic number: my example was no more overwrought than OP's rule.
- mattkrause 7y agoIt depends on why you're using the 2. In some cases, I'd say that 1 can be a magic number. For example, it would better to write fprintf(STDOUT, output_string) than fprintf(1, output_string) However, 0 and ±1 have a special role in picking out the first/next/previous elements of a sequence (and related things), which is so common that it'd be silly to insist on defining POSSIBLE_NEXT_INDEX and POSSIBLE_PREDECESSOR. That said, people do seem to love Python's itertools, so....maybe that's where we're headed. I had somebody aggressively complain about the readability of the all-pairs for-loop, which I thought was basically standard. for(auto i=0; i<N-1; i++) for(auto j=i+1; j<N; j++) process(X[i], X[j]) The flip side is that I don't think you always need to do this. For example, this is silly: double triangle::area() const { const double NORMALIZATION = 1/2.0; return this->base * this->height * NORMALIZATION; } The point is just to make it clear why that particular number is being used and where it came from.
- rmtech 7y agoThe all pairs loop is unnecessarily low level, and it would be hard to spot a mistake there. It would be great if there was a way to say for i < j <= N as this is super clear.
- mattkrause 7y agoI guess so. I don't think it's atrocious: it looks like iterating over the upper/lower triangular part of a matrix to me, which is fairly common (in some domains, I guess). Plus, I like that the double for-loop indicates slowness. However, Python has itertools.combinations(X,2) and Julia has IterTools.subsets(X,2) if that's what you want.
- klyrs 7y agoI think you mean # see __magic_numbers.py itertools.combinations(X, number_of_things_in_a_pair)
- deleted 7y ago[deleted]
- mattkrause 7y agoHa! You’re clearly taking the mickey but... Some things only/obviously make sense over pairs of items. For those, go with a literal 2 for x,y in itertools.combinations(obj, 2): if is_overlapping(x,y): raise OverlapError(x,y) However, sometimes the subset’s size just happens to be two (but you might change it), maybe a constant would be good. Ditto if you’re doing some math where there are “real” 2s that are part of a formula and incidental ones that are due to the subset size. For example: subset_size = 2 for subset in itertools.combinations(X, subset_size): mse.append(sum((subset - target)**2)/subset_size) is a bit more flexible and more clear than using all 2s, IMO, and at very little cost (YAGNI blah blah, but I think that’s an argument for not making a whole configuration system that lets you set the size at runtime).
- klyrs 7y ago> Ha! You’re clearly taking the mickey but... Only in my choice of variable name. OP drew a line at 0, 1 and -1. What I did there was highlight that the implications of that rule are absurd. See how your sum of squares also contains a 2? VERBOTEN!!!! And don't you dare re-use "subset_size" ;) This is somewhat akin to Dijkstra's opinion on goto. Which is actually great advice when you're doing apps in javascript, but doesn't get you very far if you're writing or generating assembly. When such advice is promoted to a taboo, I side with Churchill: this is the type of arrant pedantry up with which I will not put. Or Emerson: foolish consistency is the hobgoblin of little minds. Yes, too many numeric literals can make code hard to read. But math is hard to read[1] because you need to really think about it -- you can't avoid the complexity; you can only rearrange it. Where you put it is a matter of taste, and absolutes have absurd consequences. As for the original notion of indexing a triangular array, I have a greater concern: for i in range(n): for j in range(i): foo(array[i][j]) this is self-documenting in the sense that I immediately know the relationship between i and j -- without reading documentation, I can't recall if itertools.combinations will give me the upper or lower triangle. In this case, I'd avoid the 2 for entirely different reasons :) [1] and I don't mean "let's go shopping!" -- I mean that reading a math paper, even for experts, can take days per page.
- crazygringo 7y agoI'm not sure where the misunderstanding is coming from. Yes, of course if you have a formula that involves dividing by 2 or something you just include the number directly. But anything that's a magic number, even if only used once, is better to have a named constant defined. The name of the constant becomes the documentation itself. The other reason is that if someone needs to come in and maintain the code and change a magic number for whatever reason... if it's a defined constant, they know it should only need to be changed in that one place, assuming all magic numbers are defined in a sufficiently wide scope. If it's just a number, they have to search the whole codebose for all instances of that number, and investigate each and every one to see if it needs to be replaced as well or not.
- benibela 7y ago>Yes, of course if you have a formula that involves dividing by 2 or something you just include the number directly. Or replace it with >> 1
- deleted 7y ago[deleted]