Summary

August 29, 2017 · View on GitHub

Members	Descriptions
`void` `init_chain(Chain` `* chain)`	Construct chain
`void` `clear_chain(Chain` `* chain)`	Clear chain
`void` `append_cstr_to_chain(Chain` `* chain,const char * text)`	Append a cstring to a chain
`void` `append_flink_to_chain(Chain` `* chain,Fraction` `fraction)`	Append fraction as single Link to chain
`void` `append_fraction_to_chain(Chain` `* chain,Fraction` `fraction)`	Append fraction as string to chain
`void` `append_chain_to_chain(Chain` `* chain1,Chain` `chain2)`	Append the contents in one chain to another
`void` `append_stream_to_chain(Chain` `* chain,FILE * stream)`	Append the contents of a stream to a chain
`void` `clear_stream(FILE * stream)`	Erase stream contents
`void` `append_chain_to_stream(Chain` `chain,FILE * stream)`	Append chain to stream
`void` `chain_to_stream(Chain` `chain,FILE * stream)`	Assign chain to stream
`int` `chain_to_cstr(Chain` `chain,char * buffer)`	Convert chain to cstring
`void` `write_chain_to_file(Chain` `chain,Chain` `filename)`	Set file contents to chain's contents
`void` `read_file_to_chain(Chain` `* chain,Chain` `filename)`	Set chain contents to file's contents
`int` `compare_chains(Chain` `a,Chain` `b)`	Compare chains
```Fraction` `chain_to_fraction(Chain` `chain)`	Convert chain to fraction
```Fraction` `get_next_byte_of_stream(FILE * file)`
`void` `runtime_error(const char * msg,...)`	Show error message and exit
```Fraction` `construct_fraction(FractionInt num,FractionInt den)`	Construct Fraction
`void` `reduce_fraction(Fraction` `* a)`	Reduce fraction to most basic form
```Fraction` `add_fractions(Fraction` `a,Fraction` `b)`	Add two fractions
```Fraction` `subtract_fractions(Fraction` `a,Fraction` `b)`	Subtract two fractions
```Fraction` `multiply_fractions(Fraction` `a,Fraction` `b)`	Multiply two fractions
```Fraction` `divide_fractions(Fraction` `a,Fraction` `b)`	Divide two fractions
```Fraction` `modulus_fractions(Fraction` `a,Fraction` `b)`	Modulus fractions
```Fraction` `factorial_fraction(Fraction` `a)`	Get factorial of fraction
`int` `compare_fractions(Fraction` `a,Fraction` `b)`	Compare fractions
```Fraction` `pow_fractions(Fraction` `a,Fraction` `b)`	Exponentiate fractions
`struct` `Chain`
`struct` `Fraction`
`struct` `Link`

Members

`void` `init_chain(Chain` `* chain)`

Construct chain

Set defaults for chain: length to 0 and start to NULL

`void` `clear_chain(Chain` `* chain)`

Clear chain

Free all links in chain and set start to NULL

`void` `append_cstr_to_chain(Chain` `* chain,const char * text)`

Append a cstring to a chain

Append each character of the cstring as a Link to the chain.

Parameters

chain The chain being modified
text The string being added to the chain

`void` `append_flink_to_chain(Chain` `* chain,Fraction` `fraction)`

Append fraction as single Link to chain

Parameters

chain The chain being modified
fraction The fraction being added to the chain

`void` `append_fraction_to_chain(Chain` `* chain,Fraction` `fraction)`

Append fraction as string to chain

Fraction is first converted into a string format. For example, 25/1 would be converted to "twenty five" and then appended to the chain

Parameters

chain The chain being modified
fraction The fraction being added to the chain

`void` `append_chain_to_chain(Chain` `* chain1,Chain` `chain2)`

Append the contents in one chain to another

Parameters

chain1 The chain being modified
chain2 The chain being appended to chain1

`void` `append_stream_to_chain(Chain` `* chain,FILE * stream)`

Append the contents of a stream to a chain

Each char is read from the stream and copied to the chain as a fraction/Link.

Parameters

chain The chain being modified
stream The stream whose contents are read

`void` `clear_stream(FILE * stream)`

Erase stream contents

`void` `append_chain_to_stream(Chain` `chain,FILE * stream)`

Append chain to stream

Print each fraction of chain to the stream to be appended as a char

Parameters

chain The chain being read
stream The stream being appended to

`void` `chain_to_stream(Chain` `chain,FILE * stream)`

Assign chain to stream

Clear the stream, then call append_chain_to_stream

Parameters

chain The chain being read
stream The stream being copied to

`int` `chain_to_cstr(Chain` `chain,char * buffer)`

Convert chain to cstring

Print each fraction of chain to the cstring buffer to be appended as a char This function is not safe. If buffer is too small to hold the contents of chain, a segfault will occur

Parameters

chain The chain being read
buffer The cstring being appended to

`void` `write_chain_to_file(Chain` `chain,Chain` `filename)`

Set file contents to chain's contents

Open a file and set its contents to that of the chain's. As with other functions, each fraction is converted to a char. An error will be thrown upon any problem opening the file

Parameters

chain The chain being read
filename A chain holding the filename of the file we're opening

`void` `read_file_to_chain(Chain` `* chain,Chain` `filename)`

Set chain contents to file's contents

Open a file and read its contents to the chain's, replacing any previous values(an assign, not append). As with other functions, each char is converted to a fraction. An error will be thrown upon any problem opening the file