Skip to content

Commit 57f5e2d

Browse files
sanderploegsmasanderploegsma
committed
[C] Space Age
1 parent 29149e7 commit 57f5e2d

File tree

9 files changed

+4113
-0
lines changed

9 files changed

+4113
-0
lines changed

‎c/space-age/HELP.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Help
2+
3+
## Running the tests
4+
5+
Get the first test compiling, linking and passing by following the [three rules of test-driven development][3-tdd-rules].
6+
7+
The included makefile can be used to create and run the tests using the `test` task.
8+
9+
```console
10+
$ make test
11+
```
12+
13+
Create just the functions you need to satisfy any compiler errors and get the test to fail.
14+
Then write just enough code to get the test to pass.
15+
Once you've done that, move onto the next test.
16+
17+
As you progress through the tests, take the time to refactor your implementation for readability and expressiveness and then go on to the next test.
18+
19+
Try to use standard C99 facilities in preference to writing your own low-level algorithms or facilities by hand.
20+
21+
## Checking for memory leaks
22+
23+
The makefile comes also with a build that checks some common mistakes regarding memory leaks and out of bound access to arrays.
24+
To run these checks, use the following at the command line:
25+
26+
```console
27+
$ make memcheck
28+
```
29+
30+
[3-tdd-rules]: https://blog.cleancoder.com/uncle-bob/2014/12/17/TheCyclesOfTDD.html
31+
32+
## Submitting your solution
33+
34+
You can submit your solution using the `exercism submit space_age.c space_age.h` command.
35+
This command will upload your solution to the Exercism website and print the solution page's URL.
36+
37+
It's possible to submit an incomplete solution which allows you to:
38+
39+
- See how others have completed the exercise
40+
- Request help from a mentor
41+
42+
## Need to get help?
43+
44+
If you'd like help solving the exercise, check the following pages:
45+
46+
- The [C track's documentation](https://exercism.org/docs/tracks/c)
47+
- The [C track's programming category on the forum](https://forum.exercism.org/c/programming/c)
48+
- [Exercism's programming category on the forum](https://forum.exercism.org/c/programming/5)
49+
- The [Frequently Asked Questions](https://exercism.org/docs/using/faqs)
50+
51+
Should those resources not suffice, you could submit your (incomplete) solution to request mentoring.
52+
53+
Make sure you have read the [C track-specific documentation][c-track] on the Exercism site.
54+
This covers the basic information on setting up the development environment expected by the exercises.
55+
56+
## Submitting Incomplete Solutions
57+
58+
If you are struggling with a particular exercise, it is possible to submit an incomplete solution so you can see how others have completed the exercise.
59+
60+
## Resources
61+
62+
To get help if having trouble, you can use the following resources:
63+
64+
- [StackOverflow][] can be used to search for your problem and see if it has been answered already. You can also ask and answer questions.
65+
- [CPPReference][] can be used to look up information on C concepts, operators, types, standard library functions and more.
66+
- [TutorialsPoint][] has similar content as CPPReference in its C programming section.
67+
- [The C Programming][K&R] book by K&R is the original source of the language and is still useful today.
68+
69+
[c-track]: https://exercism.org/docs/tracks/c
70+
[stackoverflow]: http://stackoverflow.com/questions/tagged/c
71+
[cppreference]: https://en.cppreference.com/w/c
72+
[tutorialspoint]: https://www.tutorialspoint.com/cprogramming/
73+
[K&R]: https://www.amazon.com/Programming-Language-2nd-Brian-Kernighan/dp/0131103628/

‎c/space-age/README.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Space Age
2+
3+
Welcome to Space Age on Exercism's C Track.
4+
If you need help running the tests or submitting your code, check out `HELP.md`.
5+
6+
## Introduction
7+
8+
The year is 2525 and you've just embarked on a journey to visit all planets in the Solar System (Mercury, Venus, Earth, Mars, Jupiter, Saturn, Uranus and Neptune).
9+
The first stop is Mercury, where customs require you to fill out a form (bureaucracy is apparently _not_ Earth-specific).
10+
As you hand over the form to the customs officer, they scrutinize it and frown.
11+
"Do you _really_ expect me to believe you're just 50 years old?
12+
You must be closer to 200 years old!"
13+
14+
Amused, you wait for the customs officer to start laughing, but they appear to be dead serious.
15+
You realize that you've entered your age in _Earth years_, but the officer expected it in _Mercury years_!
16+
As Mercury's orbital period around the sun is significantly shorter than Earth, you're actually a lot older in Mercury years.
17+
After some quick calculations, you're able to provide your age in Mercury Years.
18+
The customs officer smiles, satisfied, and waves you through.
19+
You make a mental note to pre-calculate your planet-specific age _before_ future customs checks, to avoid such mix-ups.
20+
21+
~~~~exercism/note
22+
If you're wondering why Pluto didn't make the cut, go watch [this YouTube video][pluto-video].
23+
24+
[pluto-video]: https://www.youtube.com/watch?v=Z_2gbGXzFbs
25+
~~~~
26+
27+
## Instructions
28+
29+
Given an age in seconds, calculate how old someone would be on a planet in our Solar System.
30+
31+
One Earth year equals 365.25 Earth days, or 31,557,600 seconds.
32+
If you were told someone was 1,000,000,000 seconds old, their age would be 31.69 Earth-years.
33+
34+
For the other planets, you have to account for their orbital period in Earth Years:
35+
36+
| Planet | Orbital period in Earth Years |
37+
| ------- | ----------------------------- |
38+
| Mercury | 0.2408467 |
39+
| Venus | 0.61519726 |
40+
| Earth | 1.0 |
41+
| Mars | 1.8808158 |
42+
| Jupiter | 11.862615 |
43+
| Saturn | 29.447498 |
44+
| Uranus | 84.016846 |
45+
| Neptune | 164.79132 |
46+
47+
~~~~exercism/note
48+
The actual length of one complete orbit of the Earth around the sun is closer to 365.256 days (1 sidereal year).
49+
The Gregorian calendar has, on average, 365.2425 days.
50+
While not entirely accurate, 365.25 is the value used in this exercise.
51+
See [Year on Wikipedia][year] for more ways to measure a year.
52+
53+
[year]: https://en.wikipedia.org/wiki/Year#Summary
54+
~~~~
55+
56+
## Source
57+
58+
### Created by
59+
60+
- @Guntau
61+
62+
### Contributed to by
63+
64+
- @bcc32
65+
- @Gamecock
66+
- @h-3-0
67+
- @patricksjackson
68+
- @QLaille
69+
- @ryanplusplus
70+
- @wolf99
71+
72+
### Based on
73+
74+
Partially inspired by Chapter 1 in Chris Pine's online Learn to Program tutorial. - https://pine.fm/LearnToProgram/?Chapter=01

‎c/space-age/makefile

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
### If you wish to use extra libraries (math.h for instance),
2+
### add their flags here (-lm in our case) in the "LIBS" variable.
3+
4+
LIBS = -lm
5+
6+
###
7+
CFLAGS = -std=c99
8+
CFLAGS += -g
9+
CFLAGS += -Wall
10+
CFLAGS += -Wextra
11+
CFLAGS += -pedantic
12+
CFLAGS += -Werror
13+
CFLAGS += -Wmissing-declarations
14+
CFLAGS += -DUNITY_SUPPORT_64 -DUNITY_OUTPUT_COLOR
15+
16+
ASANFLAGS = -fsanitize=address
17+
ASANFLAGS += -fno-common
18+
ASANFLAGS += -fno-omit-frame-pointer
19+
20+
.PHONY: test
21+
test: tests.out
22+
@./tests.out
23+
24+
.PHONY: memcheck
25+
memcheck: ./*.c ./*.h
26+
@echo Compiling $@
27+
@$(CC) $(ASANFLAGS) $(CFLAGS) test-framework/unity.c ./*.c -o memcheck.out $(LIBS)
28+
@./memcheck.out
29+
@echo "Memory check passed"
30+
31+
.PHONY: clean
32+
clean:
33+
rm -rf *.o *.out *.out.dSYM
34+
35+
tests.out: ./*.c ./*.h
36+
@echo Compiling $@
37+
@$(CC) $(CFLAGS) test-framework/unity.c ./*.c -o tests.out $(LIBS)

‎c/space-age/space_age.c

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#include "space_age.h"
2+
3+
const float seconds_per_earth_year = 31557600.0f;
4+
5+
static float orbital_periods[] = {
6+
0.2408467f,
7+
0.61519726f,
8+
1.0f,
9+
1.8808158f,
10+
11.862615f,
11+
29.447498f,
12+
84.016846f,
13+
164.79132f};
14+
15+
float age(planet_t planet, int64_t seconds)
16+
{
17+
if (planet < MERCURY || planet > NEPTUNE)
18+
{
19+
return INVALID_PLANET;
20+
}
21+
22+
return ((float)seconds) / seconds_per_earth_year / orbital_periods[planet];
23+
}

‎c/space-age/space_age.h

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#ifndef SPACE_AGE_H
2+
#define SPACE_AGE_H
3+
4+
#include <stdint.h>
5+
6+
#define INVALID_PLANET -1
7+
8+
typedef enum planet
9+
{
10+
MERCURY,
11+
VENUS,
12+
EARTH,
13+
MARS,
14+
JUPITER,
15+
SATURN,
16+
URANUS,
17+
NEPTUNE,
18+
} planet_t;
19+
20+
float age(planet_t planet, int64_t seconds);
21+
22+
#endif

0 commit comments

Comments
 (0)