Historia Tomka - przeciążanie

If debugging is the process of removing bugs, then programming must be the process of putting them in. ~Author Unknown

My software never has bugs. It works *exactly* as I wrote it! ~ Author Unknown

Dzisiejsza historia oparta jest, w większości, na faktach. Ukryliśmy tylko imię naszego programisty.

Był sobie Tomek programista. Tomek miał do napisania w C# fragment większego algorytmu. Jako, że kod był dobrze podzielony mogło to zrobić wiele osób. Jedną z rzeczy które miały być w tym fragmencie było stworzenie wektora z dwóch elementów:

[1 Math.Pow(Math.Sqrt(2), -BassCorrectRaw)-1]

Tomek nie był pozostawiony sam sobie. Miał API, które było dość rozbudowane.
Był dostępny typ VectorDouble jak poniżej:

public class VectorDouble : Vector<double>, IVectorDoubleReadOnly

{                       

    public VectorDouble() : base()

    { }

 

    public VectorDouble(int size) : base(size)

    { }

 

    public VectorDouble(int size, double value) : base(size, value) 

    { }

 

    public VectorDouble(params double[] vector) : base(vector)

    { }       

   //...

}

Wystarczyło go użyć i zainicjować wartościami co też nasz bohater uczynił. Napisał taki oto kod:

IVectorDoubleReadOnly BassCorrectCoefA = new VectorDouble(1, Math.Pow(Math.Sqrt(2), -BassCorrectRaw) - 1);

Widzicie już problem Tomcia? Jeśli chcecie pomyśleć sami to nie klikajcie na poniższy link. Jak już się zdecydujecie to zapraszam do dalszego czytania.

Pokaż rozwiązanie

Problemem Tomcia są dwa szczególne konstruktory w klasie VectorDouble. Tomek chciał wywołać konstruktor przyjmujący params double[] vector natomiast ponieważ użył wartości "1", wykonał się nie ten konstruktor, który zamierzał. Tomek ma review kodu, ma w firmie Unit testy a jednak ten błąd przemknął się i przez dość długi czas pozostawał niewykryty powodując błędne kalkulacje. A rozwiązanie jest banalne:

IVectorDoubleReadOnly BassCorrectCoefA = new VectorDouble(1d, Math.Pow(Math.Sqrt(2), -BassCorrectRaw) - 1);

Tak. Dobrze widzicie. Poprawne i niepoprawne użycie różni się tylko literką "d". Łatwo to przegapić.

Pytanie czy to nieznajomość Tomka spowodowała błąd czy jednak API nie jest na tyle przejrzyste, aby takim sytuacjom zapobiegać? Jak uważacie?

DevDay we Wrocławiu

Dawno już żadne techniczne posty nie świeciły na kartach tego bloga. Jako, że szybko nie zanosi się na zmianę (tak, ja też nad tym ubolewam) postanowiłem napisać trochę nietechnicznie - przynajmniej tyle się pojawi.

Dziś informacja o "konferencji", którą organizujemy w ramach grupy Wroc.NET. Piszę "konferencji", gdyż jest to bardziej rozbudowanie spotkanie grupy niż konferencja z wielkiego zdarzenia, tak czy inaczej warto o niej wspomnieć. Już 7-go grudnia będziemy mieli okazję posłuchać o 3 ciekawych tematach: będące ostatnio na topie Windows Phone 7, oraz Azure oraz bardziej corowo-techniczny o pisaniu wtycznek do .NETtwych aplikacji bez posiadania do nich źródeł. Zapowiada się niezwykle ciekawie.
Ja szczególnie czekam na ten 3 temat. Poniżej dokładne tematy sesji.

• Bartłomiej Zass - Wprowadzenie do Windows Azure
• Michał Czerwiński - Studium przypadku: wtyczka w .NET do dowolnego programu w .NET
• Daniel Dudek - Cykl życia aplikacji WP7

Więcej informacji oraz rejestracja na: http://wroc.devday.pl. Gdyby, ktoś chciał odwiedzić podobne wydarzenie a do Wrocławia miał za daleko to koledzy z łódzkiej grupy organizują podobne wydarzenie 3 dni wcześniej. Szczegóły na http://devday.pl

Zapraszam!