Sophie

Sophie

distrib > Fedora > 13 > i386 > media > os > by-pkgid > 0d67d3f1445b059d27e41f3a09f4032a > files > 12

kpolynome-0.1.2-15.fc12.i686.rpm

<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kpolynome "<application>kpolynome</application>">
  <!ENTITY kappname "&kpolynome;"><!-- Do *not* replace kappname-->
  <!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc -->
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE"><!-- change language only here -->
]> 

<!-- The language must NOT be changed here. -->

<book lang="&language;">

<!-- This header contains all of the meta-information for the document such
as Authors, publish date, the abstract, and Keywords -->

<bookinfo>
<title>The &kpolynome; Handbook</title>

<authorgroup>
<author>
<firstname>Janos</firstname>
<othername></othername>
<surname>Toberling</surname>
<affiliation>
<address><email>tobi54&#64;users&#46;sourceforge&#46;net</email></address>
</affiliation>
</author>
</authorgroup>

<!-- TRANS:ROLES_OF_TRANSLATORS -->

<copyright>
<year>2005</year>
<holder>Janos Toberling</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>

<date>2005-04-17</date>
<releaseinfo>0.1</releaseinfo>

<!-- Abstract about this handbook -->

<abstract>
	<para>
	&kpolynome; is a KDE application designed to calculate mathematical polynomes based on given data coordinates.
	</para>
</abstract>

<keywordset>
	<keyword>KDE</keyword>
	<keyword>kpolynome</keyword>
	<keyword>polynome</keyword>
	<keyword>coefficient</keyword>
	<keyword>function curve</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>
	<para>
	&kpolynome; is a &kde; application designed to calculate mathematical polynomes based on given data coordinates.
	</para><para>
	You can enter data coordinate points and give a searched power. This application calculates a mathemetical polinom 
	that can best "fit" - maybe hits these points.
	</para><para>
	The points sould be entered in (X,Y) pairs.
	</para><para>
	The program has a textfile interface so you can load the dataset and save the results.
	</para>
	<para>You can also draw the functional curve and save this image to a file.
	</para>
	<para>Here is a short example:</para>
	<para>Let's assume you measured the following: ((-1,1), (0,0), (1,1)).
	What is the function that hits theese points? Let's enter the coordinates to the program and set index to 2.You will get the result x^2.
	</para>
</chapter>

<chapter id="using-kpolynome">
<title>Using &kpolynome;</title>

	<sect1 id="kpolynome-maindialog">
	<title>KPolynome main screen</title>
		<para>
		
		Here's a screenshot of the main screen of &kpolynome;.
		</para><para>
		<screenshot>
			<screeninfo>Here's a screenshot of the main screen of &kpolynome;</screeninfo>
				<mediaobject>
				<imageobject>
				<imagedata fileref="screenshot_main.png" format="PNG"/>
				</imageobject>	
				<textobject>
				<phrase>Screenshot: Main dialog</phrase>
				</textobject>
				</mediaobject>
			</screenshot>
		</para>
		<informaltable>
		<tgroup cols="2">
		<thead>
			<row>
				<entry>Element</entry>
				<entry>Function</entry>
			</row>
		</thead>
		<tbody>
			<row>
				<entry>Data Entry Area</entry>
			</row>
			<row>
				<entry>- CoordinatePair Entry</entry>
				<entry>The (X,Y) data.</entry>
			</row>
			<row>
				<entry>- List of added pairs</entry>
				<entry>Short list with the entered coordinates</entry>
			</row>
			<row>
				<entry>- Control buttons</entry>
				<entry>You can add coordinate or modify/delete the selected one.</entry>
			</row>
			<row>
				<entry>- Searched degree</entry>
				<entry>The desired degree of the calculated polinome</entry>
			</row>
			<row>
				<entry>Calculation results</entry>				
			</row>
			<row>
				<entry>- Power</entry>
				<entry>Element of the polinome</entry>
			</row>
			<row>
				<entry>- Calculated coefficients</entry>
				<entry>The calculated coefficient for current the element.</entry>
			</row>
			<row>
				<entry>- Divergences</entry>
				<entry>Empiric and corrected empiric divergences.</entry>
			</row>
			<row>
				<entry>Program contoll</entry>
				<entry></entry>
			</row>
			<row>
				<entry>- Show Graph</entry>
				<entry>Invokes the drawing dialog.</entry>
			</row>
			<row>
				<entry>- Load and Save</entry>
				<entry>Import and export data.</entry>
			</row>
		</tbody>
		</tgroup>
		</informaltable>
	</sect1>

	<sect1 id="kpolynome-curevedialog">
	<title>KPolynome curve drawing dialog</title>
		
		<para>Here's the screenshot of the curve drawing dialog:</para>
		<para>
			<screenshot>
			<screeninfo>Here's a screenshot of the curve drawing screen of &kpolynome;</screeninfo>
				<mediaobject>
				<imageobject>
				<imagedata fileref="screenshot_curve.png" format="PNG"/>
				</imageobject>	
				<textobject>
				<phrase>Screenshot: Curve drawing</phrase>
				</textobject>
				</mediaobject>
			</screenshot>
		</para>
		<informaltable>
		<tgroup cols="2">
		<thead>
			<row>
				<entry>Element</entry>
				<entry>Function</entry>
			</row>
		</thead>
		<tbody>
			<row>
				<entry>Functional parameters</entry>
				<entry>Input and calculated data.</entry>
			</row>
			<row>
				<entry>Drawing area</entry>
				<entry>You will see the image here.</entry>
			</row>
			<row>
				<entry>Modify drawing area</entry>
				<entry>Scroll, Zoom and Autofit the screen.</entry>
			</row>
			<row>
				<entry>Save function curve</entry>
				<entry>Press this button to save the image.</entry>
			</row>
			<row>
				<entry>TopRight/BottomLeft coordinates</entry>
				<entry>Controlls the drawing window.</entry>
			</row>
			<row>
				<entry>Mouse Position</entry>
				<entry>Shows the mouse coordinates in the drawing area.</entry>
			</row>
		</tbody>
		</tgroup>
		</informaltable>
	</sect1>

	<sect1 id="kpolynome-textiface">
	<title>Loading and saving data</title>
		
		<para>KPolynome has a simple input/output interface where you can load the coordinates and 
		save the results. The loading and saving can be started from the main dialog save and load button.</para>
		<para>The defaule extension of the file comes form KPolynome_DataSet ".kpds". </para>
		<para>Here follows an example for the dataset ((0,0),(1,1),(-1,-1),(2,8)) with searched power 3:
		</para>
		<informaltable>
		<tgroup cols="2">
			<thead>
			<row>
				<entry>Input file</entry>
				<entry>Output file</entry>
			</row>
			</thead>
			<tbody>
				<row>
				<entry>
					<para>Num_points:&#160;4</para>
					<para>(&#160;&#160;&#160;&#160;&#160;0 ;&#160;&#160;&#160;&#160;&#160;0 )</para>
					<para>(&#160;&#160;&#160;&#160;&#160;1 ;&#160;&#160;&#160;&#160;&#160;1 )</para>
					<para>(&#160;&#160;&#160;&#160;&#160;-1 ;&#160;&#160;&#160;&#160;&#160;-1 )</para>
					<para>(&#160;&#160;&#160;&#160;&#160;2;&#160;&#160;&#160;&#160;&#160;8 )</para>
					<para>Num_ads: 3</para>
				</entry>
				<entry>
					<para>Num_points:&#160;4</para>
					<para>(&#160;&#160;&#160;&#160;&#160;0 ;&#160;&#160;&#160;&#160;&#160;0 )</para>
					<para>(&#160;&#160;&#160;&#160;&#160;1 ;&#160;&#160;&#160;&#160;&#160;1 )</para>
					<para>(&#160;&#160;&#160;&#160;&#160;-1 ;&#160;&#160;&#160;&#160;&#160;-1 )</para>
					<para>(&#160;&#160;&#160;&#160;&#160;2;&#160;&#160;&#160;&#160;&#160;8 )</para>
					<para>Num_ads: 3</para>
					<para>------ Calculated_data ------</para>
					<para>x^0 =&#160;&#160;&#160;&#160;&#160;0</para>
					<para>x^1 =&#160;&#160;&#160;&#160;&#160;0</para>
					<para>x^2 =&#160;&#160;&#160;&#160;&#160;0</para>
					<para>x^3 =&#160;&#160;&#160;&#160;&#160;1</para>
					<para></para>
					<para>sigma =&#160;&#160;&#160;&#160;&#160;0&#160;&#160;&#160;&#160;&#160;sigma^* = 0</para>
				</entry>
			</row>
			</tbody>
		</tgroup>
		</informaltable>
		<para>
		
		</para>
	</sect1>
</chapter>

<chapter id="faq">
<title>Questions and Answers</title>

<qandaset id="faqlist">
<qandaentry>
	<question>
	<para>Why can I see divergence such as xxxe-yy?</para>
	</question>
	<answer>
	<para>
	KPolynome wants to be as precise as it can be. So inside the calculation ruotines I use long double variables to store numbers. Insted of printing the results in a form where the "little" calculation failures are unseeable I print out all the result to the screen - includeing the failure also. 
	</para><para>So you sould understand what is the output of the program.</para>
	</answer>
</qandaentry>
</qandaset>

</chapter>

<chapter id="credits">

<title>Credits and License</title>

<para>
&kpolynome;
</para>
<para>
Program copyright 2004 Janos Toberling <email>tobi&#64;rakis&#46;homeip&#46;net</email>
</para>

<para>
Documentation copyright 2004 Janos Toberling <email>tobi&#64;rakis&#46;homeip&#46;net</email>
</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;               <!-- FDL: do not remove -->
&underGPL;        	 <!-- GPL License -->
</chapter>

<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-kpolynome">
<title>How to obtain &kpolynome;</title>
<para>
	You can found &kpolynome; at <ulink url="http://kde-apps.org">kde-apps.org</ulink>, 
	or at <ulink url="http://sourceforge.net/">sourceforge.net</ulink> .</para><para>
	At kde-apps.org you can find on the following url: <ulink url="http://kde-apps.org/content/show.php?content=22712">http://kde-apps.org/content/show.php?content=22712</ulink>. (No packages are here but on sourceforge.)</para><para>
	At sourceforge.net the project's home resides at <ulink url="http://sourceforge.net/projects/kpolynome">http://sourceforge.net/projects/kpolynome</ulink>. Here you can find the source and some precompiled packages for SuSE92_KDE34. The newest developments are in the <ulink url="http://sourceforge.net/cvs/?group_id=134106">CVS</ulink> system of sourceforge.
</para>

</sect1>

<sect1 id="requirements">
<title>Requirements</title>

<para>
In order to successfully use &kpolynome;, you need &kde; 3.x. .
</para>

<para>
All required sources to compile &kpolynome; can be found
on <ulink url="http://sourceforge.net/projects/kpolynome">The &kpolynome; home page</ulink>.
</para>

<!-- For a list of updates, you may refer to the application web site
or the ChangeLog file, or ... -->
<para>
You can find a list of changes at <ulink url="http://kde-apps.org/content/show.php?content=22712">http://kde-apps.org/content/show.php?content=22712</ulink>
</para>
</sect1>

<sect1 id="compilation">
<title>Compilation and Installation</title>

&install.compile.documentation;

</sect1>

</appendix>

&documentation.index;
</book>

<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:

vim:tabstop=2:shiftwidth=2:expandtab 
-->