1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>AForge</name>
- </assembly>
- <members>
- <member name="T:AForge.CommunicationBufferEventArgs">
- <summary>
- Event arguments holding a buffer sent or received during some communication process.
- </summary>
- </member>
- <member name="M:AForge.CommunicationBufferEventArgs.#ctor(System.Byte[])">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.CommunicationBufferEventArgs"/> class.
- </summary>
-
- <param name="message">Message being transfered during communication process.</param>
-
- </member>
- <member name="M:AForge.CommunicationBufferEventArgs.#ctor(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.CommunicationBufferEventArgs"/> class.
- </summary>
-
- <param name="buffer">Buffer containing the message being transferred during communication process.</param>
- <param name="index">Starting index of the message within the buffer.</param>
- <param name="length">Length of the message within the buffer.</param>
-
- </member>
- <member name="M:AForge.CommunicationBufferEventArgs.GetMessage">
- <summary>
- Get the transfered message.
- </summary>
-
- <returns>Returns copy of the transfered message.</returns>
-
- </member>
- <member name="M:AForge.CommunicationBufferEventArgs.GetMessageString">
- <summary>
- Get the transferred message as string.
- </summary>
-
- <returns>Returns string encoding the transferred message.</returns>
-
- </member>
- <member name="P:AForge.CommunicationBufferEventArgs.MessageLength">
- <summary>
- Length of the transfered message.
- </summary>
- </member>
- <member name="T:AForge.IntPoint">
- <summary>
- Structure for representing a pair of coordinates of integer type.
- </summary>
-
- <remarks><para>The structure is used to store a pair of integer coordinates.</para>
-
- <para>Sample usage:</para>
- <code>
- // assigning coordinates in the constructor
- IntPoint p1 = new IntPoint( 10, 20 );
- // creating a point and assigning coordinates later
- IntPoint p2;
- p2.X = 30;
- p2.Y = 40;
- // calculating distance between two points
- float distance = p1.DistanceTo( p2 );
- </code>
- </remarks>
-
- </member>
- <member name="F:AForge.IntPoint.X">
- <summary>
- X coordinate.
- </summary>
-
- </member>
- <member name="F:AForge.IntPoint.Y">
- <summary>
- Y coordinate.
- </summary>
-
- </member>
- <member name="M:AForge.IntPoint.#ctor(System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.IntPoint"/> structure.
- </summary>
-
- <param name="x">X axis coordinate.</param>
- <param name="y">Y axis coordinate.</param>
-
- </member>
- <member name="M:AForge.IntPoint.DistanceTo(AForge.IntPoint)">
- <summary>
- Calculate Euclidean distance between two points.
- </summary>
-
- <param name="anotherPoint">Point to calculate distance to.</param>
-
- <returns>Returns Euclidean distance between this point and
- <paramref name="anotherPoint"/> points.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.SquaredDistanceTo(AForge.Point)">
- <summary>
- Calculate squared Euclidean distance between two points.
- </summary>
-
- <param name="anotherPoint">Point to calculate distance to.</param>
-
- <returns>Returns squared Euclidean distance between this point and
- <paramref name="anotherPoint"/> points.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.op_Addition(AForge.IntPoint,AForge.IntPoint)">
- <summary>
- Addition operator - adds values of two points.
- </summary>
-
- <param name="point1">First point for addition.</param>
- <param name="point2">Second point for addition.</param>
-
- <returns>Returns new point which coordinates equal to sum of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.Add(AForge.IntPoint,AForge.IntPoint)">
- <summary>
- Addition operator - adds values of two points.
- </summary>
-
- <param name="point1">First point for addition.</param>
- <param name="point2">Second point for addition.</param>
-
- <returns>Returns new point which coordinates equal to sum of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.op_Subtraction(AForge.IntPoint,AForge.IntPoint)">
- <summary>
- Subtraction operator - subtracts values of two points.
- </summary>
-
- <param name="point1">Point to subtract from.</param>
- <param name="point2">Point to subtract.</param>
-
- <returns>Returns new point which coordinates equal to difference of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.Subtract(AForge.IntPoint,AForge.IntPoint)">
- <summary>
- Subtraction operator - subtracts values of two points.
- </summary>
-
- <param name="point1">Point to subtract from.</param>
- <param name="point2">Point to subtract.</param>
-
- <returns>Returns new point which coordinates equal to difference of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.op_Addition(AForge.IntPoint,System.Int32)">
- <summary>
- Addition operator - adds scalar to the specified point.
- </summary>
-
- <param name="point">Point to increase coordinates of.</param>
- <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point increased by specified value.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.Add(AForge.IntPoint,System.Int32)">
- <summary>
- Addition operator - adds scalar to the specified point.
- </summary>
-
- <param name="point">Point to increase coordinates of.</param>
- <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point increased by specified value.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.op_Subtraction(AForge.IntPoint,System.Int32)">
- <summary>
- Subtraction operator - subtracts scalar from the specified point.
- </summary>
-
- <param name="point">Point to decrease coordinates of.</param>
- <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point decreased by specified value.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.Subtract(AForge.IntPoint,System.Int32)">
- <summary>
- Subtraction operator - subtracts scalar from the specified point.
- </summary>
-
- <param name="point">Point to decrease coordinates of.</param>
- <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point decreased by specified value.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.op_Multiply(AForge.IntPoint,System.Int32)">
- <summary>
- Multiplication operator - multiplies coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to multiply coordinates of.</param>
- <param name="factor">Multiplication factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point multiplied by specified value.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.Multiply(AForge.IntPoint,System.Int32)">
- <summary>
- Multiplication operator - multiplies coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to multiply coordinates of.</param>
- <param name="factor">Multiplication factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point multiplied by specified value.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.op_Division(AForge.IntPoint,System.Int32)">
- <summary>
- Division operator - divides coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to divide coordinates of.</param>
- <param name="factor">Division factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point divided by specified value.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.Divide(AForge.IntPoint,System.Int32)">
- <summary>
- Division operator - divides coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to divide coordinates of.</param>
- <param name="factor">Division factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point divided by specified value.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.op_Equality(AForge.IntPoint,AForge.IntPoint)">
- <summary>
- Equality operator - checks if two points have equal coordinates.
- </summary>
-
- <param name="point1">First point to check.</param>
- <param name="point2">Second point to check.</param>
-
- <returns>Returns <see langword="true"/> if coordinates of specified
- points are equal.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.op_Inequality(AForge.IntPoint,AForge.IntPoint)">
- <summary>
- Inequality operator - checks if two points have different coordinates.
- </summary>
-
- <param name="point1">First point to check.</param>
- <param name="point2">Second point to check.</param>
-
- <returns>Returns <see langword="true"/> if coordinates of specified
- points are not equal.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.Equals(System.Object)">
- <summary>
- Check if this instance of <see cref="T:AForge.IntPoint"/> equal to the specified one.
- </summary>
-
- <param name="obj">Another point to check equalty to.</param>
-
- <returns>Return <see langword="true"/> if objects are equal.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.GetHashCode">
- <summary>
- Get hash code for this instance.
- </summary>
-
- <returns>Returns the hash code for this instance.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.op_Implicit(AForge.IntPoint)~AForge.Point">
- <summary>
- Implicit conversion to <see cref="T:AForge.Point"/>.
- </summary>
-
- <param name="point">Integer point to convert to single precision point.</param>
-
- <returns>Returns new single precision point which coordinates are implicitly converted
- to floats from coordinates of the specified integer point.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.op_Implicit(AForge.IntPoint)~AForge.DoublePoint">
- <summary>
- Implicit conversion to <see cref="T:AForge.DoublePoint"/>.
- </summary>
-
- <param name="point">Integer point to convert to double precision point.</param>
-
- <returns>Returns new double precision point which coordinates are implicitly converted
- to doubles from coordinates of the specified integer point.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.ToString">
- <summary>
- Get string representation of the class.
- </summary>
-
- <returns>Returns string, which contains values of the point in readable form.</returns>
-
- </member>
- <member name="M:AForge.IntPoint.EuclideanNorm">
- <summary>
- Calculate Euclidean norm of the vector comprised of the point's
- coordinates - distance from (0, 0) in other words.
- </summary>
-
- <returns>Returns point's distance from (0, 0) point.</returns>
-
- </member>
- <member name="T:AForge.PolishExpression">
- <summary>
- Evaluator of expressions written in reverse polish notation.
- </summary>
-
- <remarks><para>The class evaluates expressions writen in reverse postfix polish notation.</para>
-
- <para>The list of supported functuins is:</para>
- <list type="bullet">
- <item><b>Arithmetic functions</b>: +, -, *, /;</item>
- <item><b>sin</b> - sine;</item>
- <item><b>cos</b> - cosine;</item>
- <item><b>ln</b> - natural logarithm;</item>
- <item><b>exp</b> - exponent;</item>
- <item><b>sqrt</b> - square root.</item>
- </list>
-
- <para>Arguments for these functions could be as usual constants, written as numbers, as variables,
- writen as $<var_number> (<b>$2</b>, for example). The variable number is zero based index
- of variables array.</para>
-
- <para>Sample usage:</para>
- <code>
- // expression written in polish notation
- string expression = "2 $0 / 3 $1 * +";
- // variables for the expression
- double[] vars = new double[] { 3, 4 };
- // expression evaluation
- double result = PolishExpression.Evaluate( expression, vars );
- </code>
- </remarks>
-
- </member>
- <member name="M:AForge.PolishExpression.Evaluate(System.String,System.Double[])">
- <summary>
- Evaluates specified expression.
- </summary>
-
- <param name="expression">Expression written in postfix polish notation.</param>
- <param name="variables">Variables for the expression.</param>
-
- <returns>Evaluated value of the expression.</returns>
-
- <exception cref="T:System.ArgumentException">Unsupported function is used in the expression.</exception>
- <exception cref="T:System.ArgumentException">Incorrect postfix polish expression.</exception>
-
- </member>
- <member name="T:AForge.DoubleRange">
- <summary>
- Represents a double range with minimum and maximum values.
- </summary>
-
- <remarks>
- <para>The class represents a double range with inclusive limits -
- both minimum and maximum values of the range are included into it.
- Mathematical notation of such range is <b>[min, max]</b>.</para>
-
- <para>Sample usage:</para>
- <code>
- // create [0.25, 1.5] range
- DoubleRange range1 = new DoubleRange( 0.25, 1.5 );
- // create [1.00, 2.25] range
- DoubleRange range2 = new DoubleRange( 1.00, 2.25 );
- // check if values is inside of the first range
- if ( range1.IsInside( 0.75 ) )
- {
- // ...
- }
- // check if the second range is inside of the first range
- if ( range1.IsInside( range2 ) )
- {
- // ...
- }
- // check if two ranges overlap
- if ( range1.IsOverlapping( range2 ) )
- {
- // ...
- }
- </code>
- </remarks>
-
- </member>
- <member name="M:AForge.DoubleRange.#ctor(System.Double,System.Double)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.DoubleRange"/> class.
- </summary>
-
- <param name="min">Minimum value of the range.</param>
- <param name="max">Maximum value of the range.</param>
-
- </member>
- <member name="M:AForge.DoubleRange.IsInside(System.Double)">
- <summary>
- Check if the specified value is inside of the range.
- </summary>
-
- <param name="x">Value to check.</param>
-
- <returns><b>True</b> if the specified value is inside of the range or
- <b>false</b> otherwise.</returns>
-
- </member>
- <member name="M:AForge.DoubleRange.IsInside(AForge.DoubleRange)">
- <summary>
- Check if the specified range is inside of the range.
- </summary>
-
- <param name="range">Range to check.</param>
-
- <returns><b>True</b> if the specified range is inside of the range or
- <b>false</b> otherwise.</returns>
-
- </member>
- <member name="M:AForge.DoubleRange.IsOverlapping(AForge.DoubleRange)">
- <summary>
- Check if the specified range overlaps with the range.
- </summary>
-
- <param name="range">Range to check for overlapping.</param>
-
- <returns><b>True</b> if the specified range overlaps with the range or
- <b>false</b> otherwise.</returns>
-
- </member>
- <member name="M:AForge.DoubleRange.ToIntRange(System.Boolean)">
- <summary>
- Convert the signle precision range to integer range.
- </summary>
-
- <param name="provideInnerRange">Specifies if inner integer range must be returned or outer range.</param>
-
- <returns>Returns integer version of the range.</returns>
-
- <remarks>If <paramref name="provideInnerRange"/> is set to <see langword="true"/>, then the
- returned integer range will always fit inside of the current single precision range.
- If it is set to <see langword="false"/>, then current single precision range will always
- fit into the returned integer range.</remarks>
-
- </member>
- <member name="M:AForge.DoubleRange.op_Equality(AForge.DoubleRange,AForge.DoubleRange)">
- <summary>
- Equality operator - checks if two ranges have equal min/max values.
- </summary>
-
- <param name="range1">First range to check.</param>
- <param name="range2">Second range to check.</param>
-
- <returns>Returns <see langword="true"/> if min/max values of specified
- ranges are equal.</returns>
-
- </member>
- <member name="M:AForge.DoubleRange.op_Inequality(AForge.DoubleRange,AForge.DoubleRange)">
- <summary>
- Inequality operator - checks if two ranges have different min/max values.
- </summary>
-
- <param name="range1">First range to check.</param>
- <param name="range2">Second range to check.</param>
-
- <returns>Returns <see langword="true"/> if min/max values of specified
- ranges are not equal.</returns>
-
- </member>
- <member name="M:AForge.DoubleRange.Equals(System.Object)">
- <summary>
- Check if this instance of <see cref="T:AForge.Range"/> equal to the specified one.
- </summary>
-
- <param name="obj">Another range to check equalty to.</param>
-
- <returns>Return <see langword="true"/> if objects are equal.</returns>
-
- </member>
- <member name="M:AForge.DoubleRange.GetHashCode">
- <summary>
- Get hash code for this instance.
- </summary>
-
- <returns>Returns the hash code for this instance.</returns>
-
- </member>
- <member name="M:AForge.DoubleRange.ToString">
- <summary>
- Get string representation of the class.
- </summary>
-
- <returns>Returns string, which contains min/max values of the range in readable form.</returns>
-
- </member>
- <member name="P:AForge.DoubleRange.Min">
- <summary>
- Minimum value of the range.
- </summary>
-
- <remarks><para>The property represents minimum value (left side limit) or the range -
- [<b>min</b>, max].</para></remarks>
-
- </member>
- <member name="P:AForge.DoubleRange.Max">
- <summary>
- Maximum value of the range.
- </summary>
-
- <remarks><para>The property represents maximum value (right side limit) or the range -
- [min, <b>max</b>].</para></remarks>
-
- </member>
- <member name="P:AForge.DoubleRange.Length">
- <summary>
- Length of the range (deffirence between maximum and minimum values).
- </summary>
- </member>
- <member name="T:AForge.MessageTransferHandler">
- <summary>
- A delegate which is used by events notifying abount sent/received message.
- </summary>
-
- <param name="sender">Event sender.</param>
- <param name="eventArgs">Event arguments containing details about the transferred message.</param>
-
- </member>
- <member name="T:AForge.Point">
- <summary>
- Structure for representing a pair of coordinates of float type.
- </summary>
-
- <remarks><para>The structure is used to store a pair of floating point
- coordinates with single precision.</para>
-
- <para>Sample usage:</para>
- <code>
- // assigning coordinates in the constructor
- Point p1 = new Point( 10, 20 );
- // creating a point and assigning coordinates later
- Point p2;
- p2.X = 30;
- p2.Y = 40;
- // calculating distance between two points
- float distance = p1.DistanceTo( p2 );
- </code>
- </remarks>
-
- </member>
- <member name="F:AForge.Point.X">
- <summary>
- X coordinate.
- </summary>
-
- </member>
- <member name="F:AForge.Point.Y">
- <summary>
- Y coordinate.
- </summary>
-
- </member>
- <member name="M:AForge.Point.#ctor(System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.Point"/> structure.
- </summary>
-
- <param name="x">X axis coordinate.</param>
- <param name="y">Y axis coordinate.</param>
-
- </member>
- <member name="M:AForge.Point.DistanceTo(AForge.Point)">
- <summary>
- Calculate Euclidean distance between two points.
- </summary>
-
- <param name="anotherPoint">Point to calculate distance to.</param>
-
- <returns>Returns Euclidean distance between this point and
- <paramref name="anotherPoint"/> points.</returns>
-
- </member>
- <member name="M:AForge.Point.SquaredDistanceTo(AForge.Point)">
- <summary>
- Calculate squared Euclidean distance between two points.
- </summary>
-
- <param name="anotherPoint">Point to calculate distance to.</param>
-
- <returns>Returns squared Euclidean distance between this point and
- <paramref name="anotherPoint"/> points.</returns>
-
- </member>
- <member name="M:AForge.Point.op_Addition(AForge.Point,AForge.Point)">
- <summary>
- Addition operator - adds values of two points.
- </summary>
-
- <param name="point1">First point for addition.</param>
- <param name="point2">Second point for addition.</param>
-
- <returns>Returns new point which coordinates equal to sum of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.Point.Add(AForge.Point,AForge.Point)">
- <summary>
- Addition operator - adds values of two points.
- </summary>
-
- <param name="point1">First point for addition.</param>
- <param name="point2">Second point for addition.</param>
-
- <returns>Returns new point which coordinates equal to sum of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.Point.op_Subtraction(AForge.Point,AForge.Point)">
- <summary>
- Subtraction operator - subtracts values of two points.
- </summary>
-
- <param name="point1">Point to subtract from.</param>
- <param name="point2">Point to subtract.</param>
-
- <returns>Returns new point which coordinates equal to difference of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.Point.Subtract(AForge.Point,AForge.Point)">
- <summary>
- Subtraction operator - subtracts values of two points.
- </summary>
-
- <param name="point1">Point to subtract from.</param>
- <param name="point2">Point to subtract.</param>
-
- <returns>Returns new point which coordinates equal to difference of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.Point.op_Addition(AForge.Point,System.Single)">
- <summary>
- Addition operator - adds scalar to the specified point.
- </summary>
-
- <param name="point">Point to increase coordinates of.</param>
- <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point increased by specified value.</returns>
-
- </member>
- <member name="M:AForge.Point.Add(AForge.Point,System.Single)">
- <summary>
- Addition operator - adds scalar to the specified point.
- </summary>
-
- <param name="point">Point to increase coordinates of.</param>
- <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point increased by specified value.</returns>
-
- </member>
- <member name="M:AForge.Point.op_Subtraction(AForge.Point,System.Single)">
- <summary>
- Subtraction operator - subtracts scalar from the specified point.
- </summary>
-
- <param name="point">Point to decrease coordinates of.</param>
- <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point decreased by specified value.</returns>
-
- </member>
- <member name="M:AForge.Point.Subtract(AForge.Point,System.Single)">
- <summary>
- Subtraction operator - subtracts scalar from the specified point.
- </summary>
-
- <param name="point">Point to decrease coordinates of.</param>
- <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point decreased by specified value.</returns>
-
- </member>
- <member name="M:AForge.Point.op_Multiply(AForge.Point,System.Single)">
- <summary>
- Multiplication operator - multiplies coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to multiply coordinates of.</param>
- <param name="factor">Multiplication factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point multiplied by specified value.</returns>
-
- </member>
- <member name="M:AForge.Point.Multiply(AForge.Point,System.Single)">
- <summary>
- Multiplication operator - multiplies coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to multiply coordinates of.</param>
- <param name="factor">Multiplication factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point multiplied by specified value.</returns>
-
- </member>
- <member name="M:AForge.Point.op_Division(AForge.Point,System.Single)">
- <summary>
- Division operator - divides coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to divide coordinates of.</param>
- <param name="factor">Division factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point divided by specified value.</returns>
-
- </member>
- <member name="M:AForge.Point.Divide(AForge.Point,System.Single)">
- <summary>
- Division operator - divides coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to divide coordinates of.</param>
- <param name="factor">Division factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point divided by specified value.</returns>
-
- </member>
- <member name="M:AForge.Point.op_Equality(AForge.Point,AForge.Point)">
- <summary>
- Equality operator - checks if two points have equal coordinates.
- </summary>
-
- <param name="point1">First point to check.</param>
- <param name="point2">Second point to check.</param>
-
- <returns>Returns <see langword="true"/> if coordinates of specified
- points are equal.</returns>
-
- </member>
- <member name="M:AForge.Point.op_Inequality(AForge.Point,AForge.Point)">
- <summary>
- Inequality operator - checks if two points have different coordinates.
- </summary>
-
- <param name="point1">First point to check.</param>
- <param name="point2">Second point to check.</param>
-
- <returns>Returns <see langword="true"/> if coordinates of specified
- points are not equal.</returns>
-
- </member>
- <member name="M:AForge.Point.Equals(System.Object)">
- <summary>
- Check if this instance of <see cref="T:AForge.Point"/> equal to the specified one.
- </summary>
-
- <param name="obj">Another point to check equalty to.</param>
-
- <returns>Return <see langword="true"/> if objects are equal.</returns>
-
- </member>
- <member name="M:AForge.Point.GetHashCode">
- <summary>
- Get hash code for this instance.
- </summary>
-
- <returns>Returns the hash code for this instance.</returns>
-
- </member>
- <member name="M:AForge.Point.op_Explicit(AForge.Point)~AForge.IntPoint">
- <summary>
- Explicit conversion to <see cref="T:AForge.IntPoint"/>.
- </summary>
-
- <param name="point">Single precision point to convert to integer point.</param>
-
- <returns>Returns new integer point which coordinates are explicitly converted
- to integers from coordinates of the specified single precision point by
- casting float values to integers value.</returns>
-
- </member>
- <member name="M:AForge.Point.op_Implicit(AForge.Point)~AForge.DoublePoint">
- <summary>
- Implicit conversion to <see cref="T:AForge.DoublePoint"/>.
- </summary>
-
- <param name="point">Single precision point to convert to double precision point.</param>
-
- <returns>Returns new double precision point which coordinates are implicitly converted
- to doubles from coordinates of the specified single precision point.</returns>
-
- </member>
- <member name="M:AForge.Point.Round">
- <summary>
- Rounds the single precision point.
- </summary>
-
- <returns>Returns new integer point, which coordinates equal to whole numbers
- nearest to the corresponding coordinates of the single precision point.</returns>
-
- </member>
- <member name="M:AForge.Point.ToString">
- <summary>
- Get string representation of the class.
- </summary>
-
- <returns>Returns string, which contains values of the point in readable form.</returns>
-
- </member>
- <member name="M:AForge.Point.EuclideanNorm">
- <summary>
- Calculate Euclidean norm of the vector comprised of the point's
- coordinates - distance from (0, 0) in other words.
- </summary>
-
- <returns>Returns point's distance from (0, 0) point.</returns>
-
- </member>
- <member name="T:AForge.IntRange">
- <summary>
- Represents an integer range with minimum and maximum values.
- </summary>
-
- <remarks>
- <para>The class represents an integer range with inclusive limits -
- both minimum and maximum values of the range are included into it.
- Mathematical notation of such range is <b>[min, max]</b>.</para>
-
- <para>Sample usage:</para>
- <code>
- // create [1, 10] range
- IntRange range1 = new IntRange( 1, 10 );
- // create [5, 15] range
- IntRange range2 = new IntRange( 5, 15 );
- // check if values is inside of the first range
- if ( range1.IsInside( 7 ) )
- {
- // ...
- }
- // check if the second range is inside of the first range
- if ( range1.IsInside( range2 ) )
- {
- // ...
- }
- // check if two ranges overlap
- if ( range1.IsOverlapping( range2 ) )
- {
- // ...
- }
- </code>
- </remarks>
-
- </member>
- <member name="M:AForge.IntRange.#ctor(System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.IntRange"/> structure.
- </summary>
-
- <param name="min">Minimum value of the range.</param>
- <param name="max">Maximum value of the range.</param>
-
- </member>
- <member name="M:AForge.IntRange.IsInside(System.Int32)">
- <summary>
- Check if the specified value is inside of the range.
- </summary>
-
- <param name="x">Value to check.</param>
-
- <returns><b>True</b> if the specified value is inside of the range or
- <b>false</b> otherwise.</returns>
-
- </member>
- <member name="M:AForge.IntRange.IsInside(AForge.IntRange)">
- <summary>
- Check if the specified range is inside of the range.
- </summary>
-
- <param name="range">Range to check.</param>
-
- <returns><b>True</b> if the specified range is inside of the range or
- <b>false</b> otherwise.</returns>
-
- </member>
- <member name="M:AForge.IntRange.IsOverlapping(AForge.IntRange)">
- <summary>
- Check if the specified range overlaps with the range.
- </summary>
-
- <param name="range">Range to check for overlapping.</param>
-
- <returns><b>True</b> if the specified range overlaps with the range or
- <b>false</b> otherwise.</returns>
-
- </member>
- <member name="M:AForge.IntRange.op_Implicit(AForge.IntRange)~AForge.Range">
- <summary>
- Implicit conversion to <see cref="T:AForge.Range"/>.
- </summary>
-
- <param name="range">Integer range to convert to single precision range.</param>
-
- <returns>Returns new single precision range which min/max values are implicitly converted
- to floats from min/max values of the specified integer range.</returns>
-
- </member>
- <member name="M:AForge.IntRange.op_Equality(AForge.IntRange,AForge.IntRange)">
- <summary>
- Equality operator - checks if two ranges have equal min/max values.
- </summary>
-
- <param name="range1">First range to check.</param>
- <param name="range2">Second range to check.</param>
-
- <returns>Returns <see langword="true"/> if min/max values of specified
- ranges are equal.</returns>
-
- </member>
- <member name="M:AForge.IntRange.op_Inequality(AForge.IntRange,AForge.IntRange)">
- <summary>
- Inequality operator - checks if two ranges have different min/max values.
- </summary>
-
- <param name="range1">First range to check.</param>
- <param name="range2">Second range to check.</param>
-
- <returns>Returns <see langword="true"/> if min/max values of specified
- ranges are not equal.</returns>
-
- </member>
- <member name="M:AForge.IntRange.Equals(System.Object)">
- <summary>
- Check if this instance of <see cref="T:AForge.Range"/> equal to the specified one.
- </summary>
-
- <param name="obj">Another range to check equalty to.</param>
-
- <returns>Return <see langword="true"/> if objects are equal.</returns>
-
- </member>
- <member name="M:AForge.IntRange.GetHashCode">
- <summary>
- Get hash code for this instance.
- </summary>
-
- <returns>Returns the hash code for this instance.</returns>
-
- </member>
- <member name="M:AForge.IntRange.ToString">
- <summary>
- Get string representation of the class.
- </summary>
-
- <returns>Returns string, which contains min/max values of the range in readable form.</returns>
-
- </member>
- <member name="P:AForge.IntRange.Min">
- <summary>
- Minimum value of the range.
- </summary>
-
- <remarks><para>The property represents minimum value (left side limit) or the range -
- [<b>min</b>, max].</para></remarks>
-
- </member>
- <member name="P:AForge.IntRange.Max">
- <summary>
- Maximum value of the range.
- </summary>
-
- <remarks><para>The property represents maximum value (right side limit) or the range -
- [min, <b>max</b>].</para></remarks>
-
- </member>
- <member name="P:AForge.IntRange.Length">
- <summary>
- Length of the range (deffirence between maximum and minimum values).
- </summary>
- </member>
- <member name="T:AForge.ThreadSafeRandom">
- <summary>
- Thread safe version of the <see cref="T:System.Random"/> class.
- </summary>
-
- <remarks><para>The class inherits the <see cref="T:System.Random"/> and overrides
- its random numbers generation methods providing thread safety by guarding call
- to the base class with a lock. See documentation to <see cref="T:System.Random"/> for
- additional information about the base class.</para></remarks>
-
- </member>
- <member name="M:AForge.ThreadSafeRandom.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.ThreadSafeRandom"/> class.
- </summary>
-
- <remarks>See <see cref="M:System.Random.Next"/> for more information.</remarks>
-
- </member>
- <member name="M:AForge.ThreadSafeRandom.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.ThreadSafeRandom"/> class.
- </summary>
-
- <remarks>A number used to calculate a starting value for the pseudo-random number sequence.
- If a negative number is specified, the absolute value of the number is used.</remarks>
-
-
- <remarks>See <see cref="M:System.Random.Next"/> for more information.</remarks>
-
- </member>
- <member name="M:AForge.ThreadSafeRandom.Next">
- <summary>
- Returns a nonnegative random number.
- </summary>
-
- <returns>Returns a 32-bit signed integer greater than or equal to zero and less than
- <see cref="F:System.Int32.MaxValue"/>.</returns>
-
- <remarks>See <see cref="M:System.Random.Next"/> for more information.</remarks>
-
- </member>
- <member name="M:AForge.ThreadSafeRandom.Next(System.Int32)">
- <summary>
- Returns a nonnegative random number less than the specified maximum.
- </summary>
-
- <param name="maxValue">The exclusive upper bound of the random number to be generated.
- <paramref name="maxValue"/> must be greater than or equal to zero.</param>
-
- <returns>Returns a 32-bit signed integer greater than or equal to zero, and less than <paramref name="maxValue"/>;
- that is, the range of return values ordinarily includes zero but not <paramref name="maxValue"/>.</returns>
-
- <remarks>See <see cref="M:System.Random.Next(System.Int32)"/> for more information.</remarks>
-
- </member>
- <member name="M:AForge.ThreadSafeRandom.Next(System.Int32,System.Int32)">
- <summary>
- Returns a random number within a specified range.
- </summary>
-
- <param name="minValue">The inclusive lower bound of the random number returned.</param>
- <param name="maxValue">The exclusive upper bound of the random number returned.
- <paramref name="maxValue"/> must be greater than or equal to <paramref name="minValue"/>.</param>
-
- <returns>Returns a 32-bit signed integer greater than or equal to <paramref name="minValue"/> and less
- than <paramref name="maxValue"/>; that is, the range of return values includes
- <paramref name="minValue"/> but not <paramref name="maxValue"/>.</returns>
-
- <remarks>See <see cref="M:System.Random.Next(System.Int32,System.Int32)"/> for more information.</remarks>
-
- </member>
- <member name="M:AForge.ThreadSafeRandom.NextBytes(System.Byte[])">
- <summary>
- Fills the elements of a specified array of bytes with random numbers.
- </summary>
-
- <param name="buffer">An array of bytes to contain random numbers.</param>
-
- <remarks>See <see cref="M:System.Random.NextBytes(System.Byte[])"/> for more information.</remarks>
-
- </member>
- <member name="M:AForge.ThreadSafeRandom.NextDouble">
- <summary>
- Returns a random number between 0.0 and 1.0.
- </summary>
-
- <returns>Returns a double-precision floating point number greater than or equal to 0.0, and less than 1.0.</returns>
-
- <remarks>See <see cref="M:System.Random.NextDouble"/> for more information.</remarks>
-
- </member>
- <member name="T:AForge.Range">
- <summary>
- Represents a range with minimum and maximum values, which are single precision numbers (floats).
- </summary>
-
- <remarks>
- <para>The class represents a single precision range with inclusive limits -
- both minimum and maximum values of the range are included into it.
- Mathematical notation of such range is <b>[min, max]</b>.</para>
-
- <para>Sample usage:</para>
- <code>
- // create [0.25, 1.5] range
- Range range1 = new Range( 0.25f, 1.5f );
- // create [1.00, 2.25] range
- Range range2 = new Range( 1.00f, 2.25f );
- // check if values is inside of the first range
- if ( range1.IsInside( 0.75f ) )
- {
- // ...
- }
- // check if the second range is inside of the first range
- if ( range1.IsInside( range2 ) )
- {
- // ...
- }
- // check if two ranges overlap
- if ( range1.IsOverlapping( range2 ) )
- {
- // ...
- }
- </code>
- </remarks>
-
- </member>
- <member name="M:AForge.Range.#ctor(System.Single,System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.Range"/> structure.
- </summary>
-
- <param name="min">Minimum value of the range.</param>
- <param name="max">Maximum value of the range.</param>
-
- </member>
- <member name="M:AForge.Range.IsInside(System.Single)">
- <summary>
- Check if the specified value is inside of the range.
- </summary>
-
- <param name="x">Value to check.</param>
-
- <returns><b>True</b> if the specified value is inside of the range or
- <b>false</b> otherwise.</returns>
-
- </member>
- <member name="M:AForge.Range.IsInside(AForge.Range)">
- <summary>
- Check if the specified range is inside of the range.
- </summary>
-
- <param name="range">Range to check.</param>
-
- <returns><b>True</b> if the specified range is inside of the range or
- <b>false</b> otherwise.</returns>
-
- </member>
- <member name="M:AForge.Range.IsOverlapping(AForge.Range)">
- <summary>
- Check if the specified range overlaps with the range.
- </summary>
-
- <param name="range">Range to check for overlapping.</param>
-
- <returns><b>True</b> if the specified range overlaps with the range or
- <b>false</b> otherwise.</returns>
-
- </member>
- <member name="M:AForge.Range.ToIntRange(System.Boolean)">
- <summary>
- Convert the signle precision range to integer range.
- </summary>
-
- <param name="provideInnerRange">Specifies if inner integer range must be returned or outer range.</param>
-
- <returns>Returns integer version of the range.</returns>
-
- <remarks>If <paramref name="provideInnerRange"/> is set to <see langword="true"/>, then the
- returned integer range will always fit inside of the current single precision range.
- If it is set to <see langword="false"/>, then current single precision range will always
- fit into the returned integer range.</remarks>
-
- </member>
- <member name="M:AForge.Range.op_Equality(AForge.Range,AForge.Range)">
- <summary>
- Equality operator - checks if two ranges have equal min/max values.
- </summary>
-
- <param name="range1">First range to check.</param>
- <param name="range2">Second range to check.</param>
-
- <returns>Returns <see langword="true"/> if min/max values of specified
- ranges are equal.</returns>
-
- </member>
- <member name="M:AForge.Range.op_Inequality(AForge.Range,AForge.Range)">
- <summary>
- Inequality operator - checks if two ranges have different min/max values.
- </summary>
-
- <param name="range1">First range to check.</param>
- <param name="range2">Second range to check.</param>
-
- <returns>Returns <see langword="true"/> if min/max values of specified
- ranges are not equal.</returns>
-
- </member>
- <member name="M:AForge.Range.Equals(System.Object)">
- <summary>
- Check if this instance of <see cref="T:AForge.Range"/> equal to the specified one.
- </summary>
-
- <param name="obj">Another range to check equalty to.</param>
-
- <returns>Return <see langword="true"/> if objects are equal.</returns>
-
- </member>
- <member name="M:AForge.Range.GetHashCode">
- <summary>
- Get hash code for this instance.
- </summary>
-
- <returns>Returns the hash code for this instance.</returns>
-
- </member>
- <member name="M:AForge.Range.ToString">
- <summary>
- Get string representation of the class.
- </summary>
-
- <returns>Returns string, which contains min/max values of the range in readable form.</returns>
-
- </member>
- <member name="P:AForge.Range.Min">
- <summary>
- Minimum value of the range.
- </summary>
-
- <remarks><para>The property represents minimum value (left side limit) or the range -
- [<b>min</b>, max].</para></remarks>
-
- </member>
- <member name="P:AForge.Range.Max">
- <summary>
- Maximum value of the range.
- </summary>
-
- <remarks><para>The property represents maximum value (right side limit) or the range -
- [min, <b>max</b>].</para></remarks>
-
- </member>
- <member name="P:AForge.Range.Length">
- <summary>
- Length of the range (deffirence between maximum and minimum values).
- </summary>
- </member>
- <member name="T:AForge.Parallel">
- <summary>
- The class provides support for parallel computations, paralleling loop's iterations.
- </summary>
-
- <remarks><para>The class allows to parallel loop's iteration computing them in separate threads,
- what allows their simultaneous execution on multiple CPUs/cores.
- </para></remarks>
-
- </member>
- <member name="M:AForge.Parallel.For(System.Int32,System.Int32,AForge.Parallel.ForLoopBody)">
- <summary>
- Executes a for-loop in which iterations may run in parallel.
- </summary>
-
- <param name="start">Loop's start index.</param>
- <param name="stop">Loop's stop index.</param>
- <param name="loopBody">Loop's body.</param>
-
- <remarks><para>The method is used to parallel for-loop running its iterations in
- different threads. The <b>start</b> and <b>stop</b> parameters define loop's
- starting and ending loop's indexes. The number of iterations is equal to <b>stop - start</b>.
- </para>
-
- <para>Sample usage:</para>
- <code>
- Parallel.For( 0, 20, delegate( int i )
- // which is equivalent to
- // for ( int i = 0; i < 20; i++ )
- {
- System.Diagnostics.Debug.WriteLine( "Iteration: " + i );
- // ...
- } );
- </code>
- </remarks>
-
- </member>
- <member name="P:AForge.Parallel.ThreadsCount">
- <summary>
- Number of threads used for parallel computations.
- </summary>
-
- <remarks><para>The property sets how many worker threads are created for paralleling
- loops' computations.</para>
-
- <para>By default the property is set to number of CPU's in the system
- (see <see cref="P:System.Environment.ProcessorCount"/>).</para>
- </remarks>
-
- </member>
- <member name="T:AForge.Parallel.ForLoopBody">
- <summary>
- Delegate defining for-loop's body.
- </summary>
-
- <param name="index">Loop's index.</param>
-
- </member>
- <member name="T:AForge.SystemTools">
- <summary>
- Set of systems tools.
- </summary>
-
- <remarks><para>The class is a container of different system tools, which are used
- across the framework. Some of these tools are platform specific, so their
- implementation is different on different platform, like .NET and Mono.</para>
- </remarks>
-
- </member>
- <member name="M:AForge.SystemTools.CopyUnmanagedMemory(System.IntPtr,System.IntPtr,System.Int32)">
- <summary>
- Copy block of unmanaged memory.
- </summary>
-
- <param name="dst">Destination pointer.</param>
- <param name="src">Source pointer.</param>
- <param name="count">Memory block's length to copy.</param>
-
- <returns>Return's value of <paramref name="dst"/> - pointer to destination.</returns>
-
- <remarks><para>This function is required because of the fact that .NET does
- not provide any way to copy unmanaged blocks, but provides only methods to
- copy from unmanaged memory to managed memory and vise versa.</para></remarks>
-
- </member>
- <member name="M:AForge.SystemTools.CopyUnmanagedMemory(System.Byte*,System.Byte*,System.Int32)">
- <summary>
- Copy block of unmanaged memory.
- </summary>
-
- <param name="dst">Destination pointer.</param>
- <param name="src">Source pointer.</param>
- <param name="count">Memory block's length to copy.</param>
-
- <returns>Return's value of <paramref name="dst"/> - pointer to destination.</returns>
-
- <remarks><para>This function is required because of the fact that .NET does
- not provide any way to copy unmanaged blocks, but provides only methods to
- copy from unmanaged memory to managed memory and vise versa.</para></remarks>
-
- </member>
- <member name="M:AForge.SystemTools.SetUnmanagedMemory(System.IntPtr,System.Int32,System.Int32)">
- <summary>
- Fill memory region with specified value.
- </summary>
-
- <param name="dst">Destination pointer.</param>
- <param name="filler">Filler byte's value.</param>
- <param name="count">Memory block's length to fill.</param>
-
- <returns>Return's value of <paramref name="dst"/> - pointer to destination.</returns>
-
- </member>
- <member name="M:AForge.SystemTools.SetUnmanagedMemory(System.Byte*,System.Int32,System.Int32)">
- <summary>
- Fill memory region with specified value.
- </summary>
-
- <param name="dst">Destination pointer.</param>
- <param name="filler">Filler byte's value.</param>
- <param name="count">Memory block's length to fill.</param>
-
- <returns>Return's value of <paramref name="dst"/> - pointer to destination.</returns>
-
- </member>
- <member name="T:AForge.ConnectionFailedException">
- <summary>
- Connection failed exception.
- </summary>
-
- <remarks><para>The exception is thrown in the case if connection to device
- has failed.</para>
- </remarks>
-
- </member>
- <member name="M:AForge.ConnectionFailedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.ConnectionFailedException"/> class.
- </summary>
-
- <param name="message">Exception's message.</param>
-
- </member>
- <member name="T:AForge.ConnectionLostException">
- <summary>
- Connection lost exception.
- </summary>
-
- <remarks><para>The exception is thrown in the case if connection to device
- is lost. When the exception is caught, user may need to reconnect to the device.</para>
- </remarks>
-
- </member>
- <member name="M:AForge.ConnectionLostException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.ConnectionLostException"/> class.
- </summary>
-
- <param name="message">Exception's message.</param>
-
- </member>
- <member name="T:AForge.NotConnectedException">
- <summary>
- Not connected exception.
- </summary>
-
- <remarks><para>The exception is thrown in the case if connection to device
- is not established, but user requests for its services.</para>
- </remarks>
-
- </member>
- <member name="M:AForge.NotConnectedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.NotConnectedException"/> class.
- </summary>
-
- <param name="message">Exception's message.</param>
-
- </member>
- <member name="T:AForge.DeviceBusyException">
- <summary>
- Device busy exception.
- </summary>
-
- <remarks><para>The exception is thrown in the case if access to certain device
- is not available due to the fact that it is currently busy handling other request/connection.</para>
- </remarks>
-
- </member>
- <member name="M:AForge.DeviceBusyException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.DeviceBusyException"/> class.
- </summary>
-
- <param name="message">Exception's message.</param>
-
- </member>
- <member name="T:AForge.DeviceErrorException">
- <summary>
- Device error exception.
- </summary>
-
- <remarks><para>The exception is thrown in the case if some error happens with a device, which
- may need to be reported to user.</para></remarks>
-
- </member>
- <member name="M:AForge.DeviceErrorException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.DeviceErrorException"/> class.
- </summary>
-
- <param name="message">Exception's message.</param>
-
- </member>
- <member name="T:AForge.DoublePoint">
- <summary>
- Structure for representing a pair of coordinates of double type.
- </summary>
-
- <remarks><para>The structure is used to store a pair of floating point
- coordinates with double precision.</para>
-
- <para>Sample usage:</para>
- <code>
- // assigning coordinates in the constructor
- DoublePoint p1 = new DoublePoint( 10, 20 );
- // creating a point and assigning coordinates later
- DoublePoint p2;
- p2.X = 30;
- p2.Y = 40;
- // calculating distance between two points
- double distance = p1.DistanceTo( p2 );
- </code>
- </remarks>
-
- </member>
- <member name="F:AForge.DoublePoint.X">
- <summary>
- X coordinate.
- </summary>
-
- </member>
- <member name="F:AForge.DoublePoint.Y">
- <summary>
- Y coordinate.
- </summary>
-
- </member>
- <member name="M:AForge.DoublePoint.#ctor(System.Double,System.Double)">
- <summary>
- Initializes a new instance of the <see cref="T:AForge.DoublePoint"/> structure.
- </summary>
-
- <param name="x">X axis coordinate.</param>
- <param name="y">Y axis coordinate.</param>
-
- </member>
- <member name="M:AForge.DoublePoint.DistanceTo(AForge.DoublePoint)">
- <summary>
- Calculate Euclidean distance between two points.
- </summary>
-
- <param name="anotherPoint">Point to calculate distance to.</param>
-
- <returns>Returns Euclidean distance between this point and
- <paramref name="anotherPoint"/> points.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.SquaredDistanceTo(AForge.DoublePoint)">
- <summary>
- Calculate squared Euclidean distance between two points.
- </summary>
-
- <param name="anotherPoint">Point to calculate distance to.</param>
-
- <returns>Returns squared Euclidean distance between this point and
- <paramref name="anotherPoint"/> points.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.op_Addition(AForge.DoublePoint,AForge.DoublePoint)">
- <summary>
- Addition operator - adds values of two points.
- </summary>
-
- <param name="point1">First point for addition.</param>
- <param name="point2">Second point for addition.</param>
-
- <returns>Returns new point which coordinates equal to sum of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.Add(AForge.DoublePoint,AForge.DoublePoint)">
- <summary>
- Addition operator - adds values of two points.
- </summary>
-
- <param name="point1">First point for addition.</param>
- <param name="point2">Second point for addition.</param>
-
- <returns>Returns new point which coordinates equal to sum of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.op_Subtraction(AForge.DoublePoint,AForge.DoublePoint)">
- <summary>
- Subtraction operator - subtracts values of two points.
- </summary>
-
- <param name="point1">Point to subtract from.</param>
- <param name="point2">Point to subtract.</param>
-
- <returns>Returns new point which coordinates equal to difference of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.Subtract(AForge.DoublePoint,AForge.DoublePoint)">
- <summary>
- Subtraction operator - subtracts values of two points.
- </summary>
-
- <param name="point1">Point to subtract from.</param>
- <param name="point2">Point to subtract.</param>
-
- <returns>Returns new point which coordinates equal to difference of corresponding
- coordinates of specified points.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.op_Addition(AForge.DoublePoint,System.Double)">
- <summary>
- Addition operator - adds scalar to the specified point.
- </summary>
-
- <param name="point">Point to increase coordinates of.</param>
- <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point increased by specified value.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.Add(AForge.DoublePoint,System.Double)">
- <summary>
- Addition operator - adds scalar to the specified point.
- </summary>
-
- <param name="point">Point to increase coordinates of.</param>
- <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point increased by specified value.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.op_Subtraction(AForge.DoublePoint,System.Double)">
- <summary>
- Subtraction operator - subtracts scalar from the specified point.
- </summary>
-
- <param name="point">Point to decrease coordinates of.</param>
- <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point decreased by specified value.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.Subtract(AForge.DoublePoint,System.Double)">
- <summary>
- Subtraction operator - subtracts scalar from the specified point.
- </summary>
-
- <param name="point">Point to decrease coordinates of.</param>
- <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point decreased by specified value.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.op_Multiply(AForge.DoublePoint,System.Double)">
- <summary>
- Multiplication operator - multiplies coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to multiply coordinates of.</param>
- <param name="factor">Multiplication factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point multiplied by specified value.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.Multiply(AForge.DoublePoint,System.Double)">
- <summary>
- Multiplication operator - multiplies coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to multiply coordinates of.</param>
- <param name="factor">Multiplication factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point multiplied by specified value.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.op_Division(AForge.DoublePoint,System.Double)">
- <summary>
- Division operator - divides coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to divide coordinates of.</param>
- <param name="factor">Division factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point divided by specified value.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.Divide(AForge.DoublePoint,System.Double)">
- <summary>
- Division operator - divides coordinates of the specified point by scalar value.
- </summary>
-
- <param name="point">Point to divide coordinates of.</param>
- <param name="factor">Division factor.</param>
-
- <returns>Returns new point which coordinates equal to coordinates of
- the specified point divided by specified value.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.op_Equality(AForge.DoublePoint,AForge.DoublePoint)">
- <summary>
- Equality operator - checks if two points have equal coordinates.
- </summary>
-
- <param name="point1">First point to check.</param>
- <param name="point2">Second point to check.</param>
-
- <returns>Returns <see langword="true"/> if coordinates of specified
- points are equal.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.op_Inequality(AForge.DoublePoint,AForge.DoublePoint)">
- <summary>
- Inequality operator - checks if two points have different coordinates.
- </summary>
-
- <param name="point1">First point to check.</param>
- <param name="point2">Second point to check.</param>
-
- <returns>Returns <see langword="true"/> if coordinates of specified
- points are not equal.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.Equals(System.Object)">
- <summary>
- Check if this instance of <see cref="T:AForge.DoublePoint"/> equal to the specified one.
- </summary>
-
- <param name="obj">Another point to check equalty to.</param>
-
- <returns>Return <see langword="true"/> if objects are equal.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.GetHashCode">
- <summary>
- Get hash code for this instance.
- </summary>
-
- <returns>Returns the hash code for this instance.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.op_Explicit(AForge.DoublePoint)~AForge.IntPoint">
- <summary>
- Explicit conversion to <see cref="T:AForge.IntPoint"/>.
- </summary>
-
- <param name="point">Double precision point to convert to integer point.</param>
-
- <returns>Returns new integer point which coordinates are explicitly converted
- to integers from coordinates of the specified double precision point by
- casting double values to integers value.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.op_Explicit(AForge.DoublePoint)~AForge.Point">
- <summary>
- Explicit conversion to <see cref="T:AForge.Point"/>.
- </summary>
-
- <param name="point">Double precision point to convert to single precision point.</param>
-
- <returns>Returns new single precision point which coordinates are explicitly converted
- to floats from coordinates of the specified double precision point by
- casting double values to float value.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.Round">
- <summary>
- Rounds the double precision point.
- </summary>
-
- <returns>Returns new integer point, which coordinates equal to whole numbers
- nearest to the corresponding coordinates of the double precision point.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.ToString">
- <summary>
- Get string representation of the class.
- </summary>
-
- <returns>Returns string, which contains values of the point in readable form.</returns>
-
- </member>
- <member name="M:AForge.DoublePoint.EuclideanNorm">
- <summary>
- Calculate Euclidean norm of the vector comprised of the point's
- coordinates - distance from (0, 0) in other words.
- </summary>
-
- <returns>Returns point's distance from (0, 0) point.</returns>
-
- </member>
- </members>
- </doc>
|