725G61 - Laboration 3 Metoder och abstrakta datatyper. Johan Falkenjack

Transkript

1 725G61 - Laboration 3 Metoder och abstrakta datatyper Johan Falkenjack October 29, 2013

2 1 Förberedelse Några av klasserna i labb 3 har samma namn som i labb 1 och 2 så antingen måste man skapa ett nytt projket eller ett nytt paket att ha klasserna i. Skapa ett nytt projekt i Eclipse eller skapa ett nytt paket i samma projekt som användes för labb 1 och 2. Fråga en labbassistent om du inte vet hur man gör. 2 Varför metoder I labb 1 lärde vi oss om variabler och den enklaste styrstrukturen if. I labb 2 gick vi vidare och lärde oss om loopar och hur man kan lagra data i arrayer. I den här labben kommer vi ta ett steg upp och börja bygga och använda metoder och abstrakta datatyper. En metod är ett stycke kod som vi gett ett namn och som därför kan återanvändas på många ställen i koden. Vi har faktiskt redan stött på ett antal metoder i kursen. Den metod vi använt mest är System.out.println() men vi har också använt oss av t.ex. Arrays.sort() och Random.nextInt(). Metoder ger oss en möjlighet att dela upp och abstrahera vår kod. Tänk till exempel att vi vill skapa ett program som styr en robot som kan baka. Då vill vi kanske skapa metoden bakebread(). I den metoden vill vi kanske i sin tur anropa metoderna misenplace() (det franska begreppet för att ha alla ingredienser och köksverktyg på plats innan man börjar laga mat), mixdough(), kneaddough(), wait() (används för att simulera jäsningen), formloaf() och useoven(). Tittar vi med specifikt på kneaddough() så kanske den innehåller en while-loop som, så länge inte degen är tillräckligt blandad, anropar metoderna fold() och press(). Skulle alla moment som ingår i att baka bröd ingå direkt i bakebread() skulle den metoden bli mycket stor och omöjlig att få en helhetskänsla för. Säg sedan att vi vill skapa en metod för att baka bullar, bakerolls(). Om all kod för att baka bullar var inbakad (pun intended) direkt i bakebread() skulle vi behöva skriva den koden igen för bakerolls(). Om koden istället är uppdelad i metoder kan vi återanvända t.ex. kneaddough() och useoven(). Bakningsexemplet är förstås bara en tankeövning, men även när vi kommer till riktiga program vill vi kunna dela upp vår kod för att kunna få en bättre överblick och lättare kunna återanvända kod. 2.1 Abstrakta datatyper En abstrakt datatyp (ofta bara kallad ADT) är en samling funktioner/metoder och en underliggande datastruktur som tillsammans modellerar lösningen på ett problem. Ett exempel på en abstrakt datatyp är en samling funktioner och en lista som gemensamt hanterar en kalender (en ökänd labb från IDAs historia är den sk Almanackan som dataingenjörerna och datavetarna hade i sin första programmeringskurs, som handlade om just en abstrakt datatyp för en kalender). I den här labben ska vi bygga en abstrakt datatyp för att hantera mängder av heltal, som i mängdlära. 1

3 (För er som programmerat tidigare och hållit på med objektorientering så kan syftet med abstrakta datatyper liknas vid syftet med klasser. Innan objektorientering och klassparadigmet slog igenom var abstrakta datatyper det sätt man använde för att bygga och hantera mer avancerade datastrukturer.) 3 Metod, funktion, procedur, predikat, subrutin? Lite om terminologi. (Överkurs) I Java används normalt sett alltid begreppet metod. Ibland stöter man dock på begreppen funktion, procedur, predikat eller subrutin också. Detta är begrepp som generellt sett betyder samma sak, eventuellt med untantag av predikat som alltid anses representera ett sanningsvärde (precis som predikat-delen av en ifeller while-sats). Den mest generella termen är subrutin. Alla metoder, funktioner, procedurer och predikat är subrutiner. Subrutin avser generellt sett ett stycke kod som kan återanvändas och anropas från andra ställen i koden. Historiskt sett använde man ofta sk goto-satser för att flytta programflödet till en viss rad i koden där subrutinen låg, idag använder man oftast namngivna subrutiner som anropas och där programflödet automatiskt fortsätter där det var efter att subrutinen avslutats. En funktion är traditionellt sett ett stycke kod som beräknar ett värde men i övrigt inte påverkar programmet. T.ex. kan vi ha en funktion som beräknar summan av två tal men som inte påverkar några andra variabler som lagras av vårt huvudprogram. En procedur är traditionellt sett ett stycke kod som förändrar programmets "state", dvs förändrar värden på olika variabler som finns lagrade i programmet. Ett spel kan t.ex. ha en procedur killallplayers() som omgående dödar alla spelarkarktärer. Ett predikat är ett specialfall av en funktion som specifikt beräknar ett sanningsvärde. Alla predikat är funktioner och används för att utföra vanliga test som förekommer ofta. T.ex. är det bättre att skapa ett predikat som kollar om en array är tom än att varje gång explicit skriva en jämförelse mellan length-attributet och 0. Metod är ett begrepp som kommer från objektorientering. Vi har än så länge inte pratat om objektorientering mer än att vi påpekat att Java är ett objektorienterat språk. En metod är en subrutin som är specifikt kopplad till en klass eller till ett objekt, vad det innebär kommer vi prata mer om i Labb 5. Vi kan dock säga redan nu att alla subrutiner i Java också, av nödvändighet, är metoder. 4 Metodens anatomi Som ni minns har vi skapat ett stort antal main-metoder hittills i kursen. I den här labben kommer vi börja skapa andra metoder som kan anropas inifrån 2

4 main-metoden. Man skriver inte metoder inne i andra metoder i Java utan inne i klasser, på samma sätt som main-metoden. Här kommer ett första exempel: 1 public class Example { 2 3 public static void main(string[] args) { 4 System.out.println(addOne(1)); 5 } 6 7 public static int addone(int prior) { 8 retu rn prior + 1; 9 } 10 } Ovan står koden för klassen Example med en main-metod samt metoden addone(). Metoden addone() tar, heltal och beräknar det nästföljande heltalet och returnerar det. Dvs vi "får tillbaka" det nästföljande talet när metoden anropas. Den första raden i metoden (raderna 3 och 7 för respektive metod ovan) är metoddeklarationen och inom måsvingarna står som vanligt en kropp som beskriver vad metoden faktiskt gör för något. Metoddeklarationen består av ett antal delar. Inte heller i den här labben kommer vi prata om vad public static innebär (alla metoder vi skriver i den här labben kommer ha public static som förled) men det tredje ordet, int, säger oss att metoden returnerar ett heltal. I parentesen står metodens parametrar. En parameter är en variabel som tilldelas när metoden anropas och används för att skicka in data i metoden. En metod kan i teorin ha hur många parametrar som helst, de separeras då med komma. Metodens namn och parametrar utgör tillsammans metodens signatur. Det är möjligt att ha flera metoder med samma namn förutsatt att de har olika parametrar. Kroppen är i det här fallet mycket enkel och består bara av en return-sats. Return-satsen används för att "skicka tillbaka" ett värde från en metod. Se Övning 3.1 för att se hur ett returvärde "fångas upp". I main-metoden demonstreras hur addone() anropas. Här skickar vi in heltalet 1 som argument till metoden. Det betyder att parametern prior i addone() kommer få värdet 1. Alltså, argumentet 1 binds till parametern prior. Värt att veta är att många använder begreppen argument och parameter synonymt men jag brukar försöka skilja dem åt på detta sätt för att tydliggöra skillnaden. Här kommer en övning där vi använder addone(). 3

5 Övning 3.1 Skapa en klass som heter Example och som innehåller en main-metod och metoden addone(). Klistra in följande kod i main-metoden: int a = 1; // Here we use an assignment to save // the returned value in a variable: int b = addone(a); int c = addone(3); addone(b); System.out.println(a); System.out.println(b); System.out.println(c); Vilken utskrift får du när du exekverar det här programmet? Försök att förutsäga vilken utskriften kommer att bli innan du exekverar programmet, kontrollera sedan om det stämmer och analysera resultatet. UPPGIFT 3.1 Skapa en klass som heter Uppgift1 och skapa en main-metod. Skapa en ny metod som heter sumoftwo() som tar två heltal som argument, dvs som har två heltalsparametrar, och returnerar summan av de två talen. Skriv sedan ett testfall i main-metoden som använder sumoftwo() för att beräkna summan av två tal och skriv ut den. 5 Miniprojekt om mängdlära Den här labben kommer vara uppbyggd kring ett litet projekt som går ut på att med hjälp av metoder och arrayer hantera enklare mängdlära. Det vi kommer bygga är i praktiken en abstrakt datatyp. En abstrakt datatyp är som sagt en kombination av en underliggande datastruktur, i det här fallet, en array, och metoder som manipulerar den strukturen. Det här låter kanske väldigt abstrakt och knöligt men under labbens gång kommer vi hela tiden ta förhållandevis små steg och när labben är över har ni förhoppningsvis lärt er både vad en abstrakt datatyp är och hur man skriver metoder. Inbyggt i Java finns klasser för att hantera mängder, vi kommer inte använda dessa i den här labben men det kan vara bra att veta för framtiden. 5.1 Förberedelse Skapa en ny klass som heter Set. Klassen ska ha en main-metod som innehåller koden i avsnitt 9. 4

6 När labben är slut ska alla rader fungera och när programmet körs ska man få följande den output som står i avsnitt 10 För varje uppgift gäller ett avsnitt i main-metoden. Kommentera ut alla avsnitt från början och avkommentera allt eftersom uppgifterna är klara. Kontrollera efter varje uppgift att utskriften ser korrekt ut. 5.2 Konstruktor, en enkel funktion Den mest grundläggande funktionen för en abstrakt datatyp är en konstruktor. En konstruktor skapar en ny instans av den abstrakta datatypen. UPPGIFT 3.2 Skapa en ny metod i Set-klassen. Metoden ska heta makeset() och inte ta några argument. Metoden ska skapa en ny heltalsarray av storleken 101. Det första elementet ska sättas till 0. Sedan ska den nya arrayen returneras. Tanken här är att värdet på första indexet i arrayen ska indikera hur många tal som finns i mängden. Den kvicke inser nu att en mängd kan ha max 100 element i vår implementation, detta är en avsiktlig förenkling. 5.3 Void-metoder En void-metod är en metod som inte returnerar något. Om vi tittar på exemplet i Avsnitt 4 igen ser vi att medan addone() returnerade ett heltal, och var deklarerad som public static int, så verkar main inte ha någon return-sats och är deklarerad som public static void. Main-metoden är inte den enda metoden som saknar returvärde, även t.ex. System.out.println() är en void-metod som saknar returvärde. Void-metoder är användbara när man vill göra ändringar i globala variabler eller t.ex. vill skriva data till någon enhet, t.ex. skriva ut till skärmen som i System.out.println() eller skriva till en fil. Globala variabler är variabler som är deklarerade utanför en specifik metod och därför är tillgänglig globalt, variabler som är deklarerade inne i metoder (eller inne i block som if-satser osv.) betraktas istället som lokala. I Java, till skillnad från många andra programmeringsspråk, finns formellt sett inga globala variabler men på den nivå vi är nu kan vi betrakta alla variabler som är deklarerade i klassen, snarare än i en metod, som globala. 5

7 Övning 3.2 Titta på exemplet med addone() igen. Skriv om exemplet så att addone inte tar något argument och saknar return-sats (detta betyder att metoden måste vara void istället). Istället ska en variabel deklareras i klassen på följande vis: 1 public static int counter = 0; För varje anrop till addone() ska värdet på counter ökas med 1. Prova sedan att skriva följande i main-metoden: addone(); addone(); addone(); Vilken utskrift får du när du exekverar det här programmet? Försök att förutsäga vilken utskriften kommer att bli innan du exekverar programmet, kontrollera sedan om det stämmer och analysera resultatet. Vad vi har gjort nu är att att vi manipulerat en global variabel. UPPGIFT 3.3 Skapa en ny void-metod i Set-klassen. Metoden ska heta prettyprint() och ta en mängd, representerad som en heltalsarray enligt den konstruktor vi skapade i Uppgift 3.2, som argument. Metoden ska skriva ut denna mängd på ett läsbart sätt, för en mängd med innehållet 1, 2 och 3 ska set{ 1, 2, 3, } skrivas ut följt av en radbrytning. Det kommer bli aktuellt att använda System.out.print() (samma som System.out.println() men utan en radbrytning på slutet) och en loop här. Bonus: Om man vill skriva ut mängden så att man slipper det sista kommat på slutet blir det lite knöligare men det är en intressant uppgift att lösa om man har tid. 5.4 Booleska metoder - predikat Ett predikat är som sagt en metod som returnerar ett sanningsvärde. Dessa är mycket användbara för att standardisera olika typer av test. 6

8 UPPGIFT 3.4 Skapa en metod i Set-klassen som heter isempty(). Metoden ska ha en mängd, representerad som en heltalsarray, som parameter och ska returnera sant om storleken på denna är 0, annars ska den returnera falskt. Skapa också en metod size() som tar en mängd, representerad som en heltalsarray, som argument och returnerar storleken på den. Tänk på att längden på en mängd inte är samma sak som längden på den underliggande arrayen. UPPGIFT 3.5 Skapa en metod i Set-klassen som heter contains(). Metoden ska ha två parametrar, en en mängd, representerad som en heltalsarray, och ett heltal. Om heltalet finns i mängden ska metoden returnera sant, annars ska den returnera falskt. Tänk på att om man returnerar inne i en loop kommer loopen avbrytas, detta kan vara både användbart och problematiskt. Tänk på hur loopens slutvillkor ska se ut, det kommer inte vara längden på arrayen som avgör utan värdet som ligger på arrayens första index. 5.5 Metoder som använder metoder I vår exempelkörning körde vi följande för att lägga till element: 1 int[] set1 = makeset(); 2 set1[1] = 1; 3 set1[0] = set1[0] + 1; 4 set1[2] = 2; 5 set1[0] = set1[0] + 1; 6 set1[3] = 3; 7 set1[0] = set1[0] + 1; Här skapade vi en mängd och lade till 3 element. För varje element vi lade till var vi tvugna att själva räkna upp storleken, som ju lagrades på index 0. Vi säger också vilket index vi lägger till ett nytt element på. Detta är klumpigt och riskerar att bli fel. Det finns inte heller någon garanti att vi inte lägger till samma tal mer än en gång. Som ni minns från er grundläggande mängdlära så innehåller en mängd max ett exemplar av varje element. Det innebär att när vi vill lägga till ett element i en mängd vill vi först se till att elementet inte redan finns i mängden. Därför ska vi skapa en metod som sköter tilläggning av element åt oss. 7

9 UPPGIFT 3.6 Skapa en ny metod som heter addelement() och som tar två parametrar, en mängd, representerad som en heltalsarray, och ett heltal. Om heltalet redan finns i mängden ska false returneras (för att signalera att inget lades till). Om inte talet redan finns i mängden ska storleken på mängden räknas upp, talet läggas till (tänk på vilket index i arrayen talet ska läggas till på) och ska returneras. UPPGIFT 3.7 Skapa en ny metod som heter remove() och som tar två parametrar, en mängd, representerad som en heltalsarray, och ett heltal. Om heltalet inte finns i mängden ska false returneras. Om heltalet finns i mängden så ta bort det och returnera. Metoden remove() kan anta att alla element i mängden är unika, dvs man behöver bara ta bort första förekomsten av ett heltal eftersom det inte ska finnas några fler. Glöm inte att räkna ner storleken på arrayen och flytta efter alla element. Att ta bort elementet 3 ur följande mängd behöver ske på följande sätt: Flytta elementen som förekommer efter indexet där 3 ligger ett index "neråt" och räkna ner första elementet som signalerar storleken på mängden. Den extra 5an som ligger på index 5 i arrayen ovan innebär inget problem då den ligger utanför det område av arrayen som används av mängden enligt det första elementet, så den kan ni låta ligga kvar: Mängdoperationer Metoderna i uppgifterna 3.6 och 3.7 var destruktiva, dvs de ändrade på någon data utanför metoden, specifikt på den mängd som skickades in. Nu ska vi skapa några icke-destruktiva metoder. Icke-destruktiva metoder ändrar inte på någon data utan skapar bara ny data. 8

10 UPPGIFT 3.8 Skapa metoden intersection() som tar två mängder, representerade som heltalsarrayer, som argument och returnerar snittet av dessa. Skapa sedan metoden union() som tar två mängder, representerade som heltalsarrayer, som argument och returnerar unionen. Mängden som returneras ska i båda fallen vara en ny mängd och den ska byggas upp genom att använda de metoder vi skapat tidigare i labben. Mängderna som skickas in ska förbli oförändrade. UPPGIFT 3.9 Skapa metoden symmetricdifference() som tar två mängder, representerade som heltalsarrayer, som argument och returnerar den symmetriska differensen, dvs de heltal som ingår i någon av mängderna men inte i båda. Använd union(), intersection() och remove() där det behövs. Om du vill kan du också implementera en metod difference() som returnerar differensen av två mängder och använda den för att implementera symmetricdifference(). Mängderna som skickas in ska förbli oförändrade. 6 Sammanfattning Vad vi har skapat nu är en abstrakt datatyp. Vi har en underliggande struktur, i vårt fall en array med heltal, och ett antal metoder för att manipulera den strukturen. I inget fall förväntas vi arbeta direkt med strukturen utan vi använder alltid dessa metoder när vi manipulerar den. Det är detta som utgör själva abstraktionen i vår abstrakta datatyp, vi kan använda datatypen utan att behöva veta vad som ligger under ytan. Tar vi det hela ett steg till innebär detta också att vi kan ändra vad som ligger under ytan i den abstrakta datatypen, se t.ex. Övning 3.3, utan att förändra hur den abstrakta datatypen används. Detta är enormt kraftfullt om vi skrivit ett helt program med tusentals rader kod som använder den abstrakta datatypen. Behöver vi ändra den abstrakta datatypens underliggande struktur behöver vi bara ändra de kanske 10 metoderna som utgör den abstrakta datatypen, inte hela programmet. Det man som ny programmerare brukar tycka är svårt är att veta var den abstrakta datatypen slutar och resten av programmet börjar. Generellt sett är den abstrakta datatypen alla de metoder som direkt manipulerar eller hämtar data ur den underliggande strukturen. Metoder som inte manipulerar den underliggande strukturen är inte del av ADT:n. Kommer man på att man behöver manipulera den underliggande strukturen på ett nytt sätt, ja då får man utöka ADT:n. Känner ni fortfarande inte att värdet av abstrakta datatyper är självklart så var inte oroliga. Det viktigaste ni ska få med er från den här labben är hur 9

11 metoder fungerar. Abstrakta datatyper, och den modernare motsvarigheten, klasser, återkommer vi till i labb 5. 7 Bonusuppgifter Här kommer några extra övningsuppgifter där vi implementerar samma abstrakta datatyp men med andra underliggande strukturer. Övning 3.3 Försök lösa uppgifterna ovan med ArrayList istället för array. Vilka problem slipper du? Hur kan du förenkla hanteringen av storleken? Övning 3.4 Googla på Javas inbyggda mängdklasser HashSet och TreeSet. Lös uppgifterna i labben ovan genom att använda någon av dessa och deras inbyggda metoder istället för heltalsarrayer eller ArrayList. Var noga i de sista uppgifterna så att inte mängderna som skickas in förändras. 8 Redovisning Nu när ni är färdiga med alla uppgifter är det dags at lämna in era lösningar för Uppgift 3.1 till 3.9 för rättning. Gå igenom era lösningar en extra gång och se till så att hi har kommenterat er kod, och testkört den noga så att ni är säkra på att alla lösningar fungerar. Samla ihop kodfilerna (filerna som slutar på.java) i ett zip-arkiv och ladda upp zip-filen under Labb3 i LISAM. Glöm inte att skriva namnen på båda gruppmedlemmarna i kommentarsfältet vid inlämningen. 9 Testkod till main-metoden System.out.println("Testing "); System.out.println("Testing makeset() and prettyprint():"); int[] set1 = makeset(); prettyprint(set1); //fake set with known size: set1[1] = 1; set1[0] = set1[0] + 1; set1[2] = 2; 10

12 set1[0] = set1[0] + 1; set1[3] = 3; set1[0] = set1[0] + 1; prettyprint(set1); System.out.println("Testing isempty() and size():"); System.out.println(isEmpty(set1)); int[] set2 = makeset(); System.out.println(isEmpty(set2)); System.out.println(size(set1)); System.out.println(size(set2)); System.out.println("Testing contains():"); System.out.println(contains(set2, 0)); System.out.println(contains(set1, 0)); System.out.println(contains(set1, 1)); System.out.println(contains(set1, 2)); System.out.println(contains(set1, 3)); System.out.println(contains(set1, 4)); System.out.println("Testing add():"); int[] set3 = makeset(); System.out.println(addElement(set3, 1)); prettyprint(set3); System.out.println(addElement(set3, 2)); prettyprint(set3); System.out.println(addElement(set3, 1)); prettyprint(set3); System.out.println("Testing remove():"); System.out.println(remove(set3, 5)); prettyprint(set3); System.out.println(remove(set3, 1)); prettyprint(set3); System.out.println(remove(set3, 2)); prettyprint(set3); System.out.println("Testing intersection():"); int[] set4 = makeset(); prettyprint(set1); addelement(set4, 3); 11

13 addelement(set4, 4); addelement(set4, 2); prettyprint(set4); prettyprint(intersection(set1, set4)); System.out.println("Testing union():"); prettyprint(set1); prettyprint(set4); prettyprint(union(set1, set4)); System.out.println("Testing symmetricdifference():"); prettyprint(set1); prettyprint(set4); prettyprint(symmetricdifference(set1, set4)); 10 Output från miniprojektet Testing Testing makeset() and prettyprint(): set{ } set{ 1, 2, 3, } Testing isempty() and size(): false 3 0 Testing contains(): false false false Testing add(): set{ 1, } 12

14 set{ 1, 2, } false set{ 1, 2, } Testing remove(): false set{ 1, 2, } set{ 2, } set{ } Testing intersection(): set{ 1, 2, 3, } set{ 3, 4, 2, } set{ 2, 3, } Testing union(): set{ 1, 2, 3, } set{ 3, 4, 2, } set{ 1, 2, 3, 4, } Testing symmetricdifference(): set{ 1, 2, 3, } set{ 3, 4, 2, } set{ 1, 4, } 13