You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1795 lines
75 KiB

1 month ago
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>AForge</name>
  5. </assembly>
  6. <members>
  7. <member name="T:AForge.MessageTransferHandler">
  8. <summary>
  9. A delegate which is used by events notifying abount sent/received message.
  10. </summary>
  11. <param name="sender">Event sender.</param>
  12. <param name="eventArgs">Event arguments containing details about the transferred message.</param>
  13. </member>
  14. <member name="T:AForge.DoublePoint">
  15. <summary>
  16. Structure for representing a pair of coordinates of double type.
  17. </summary>
  18. <remarks><para>The structure is used to store a pair of floating point
  19. coordinates with double precision.</para>
  20. <para>Sample usage:</para>
  21. <code>
  22. // assigning coordinates in the constructor
  23. DoublePoint p1 = new DoublePoint( 10, 20 );
  24. // creating a point and assigning coordinates later
  25. DoublePoint p2;
  26. p2.X = 30;
  27. p2.Y = 40;
  28. // calculating distance between two points
  29. double distance = p1.DistanceTo( p2 );
  30. </code>
  31. </remarks>
  32. </member>
  33. <member name="F:AForge.DoublePoint.X">
  34. <summary>
  35. X coordinate.
  36. </summary>
  37. </member>
  38. <member name="F:AForge.DoublePoint.Y">
  39. <summary>
  40. Y coordinate.
  41. </summary>
  42. </member>
  43. <member name="M:AForge.DoublePoint.#ctor(System.Double,System.Double)">
  44. <summary>
  45. Initializes a new instance of the <see cref="T:AForge.DoublePoint"/> structure.
  46. </summary>
  47. <param name="x">X axis coordinate.</param>
  48. <param name="y">Y axis coordinate.</param>
  49. </member>
  50. <member name="M:AForge.DoublePoint.DistanceTo(AForge.DoublePoint)">
  51. <summary>
  52. Calculate Euclidean distance between two points.
  53. </summary>
  54. <param name="anotherPoint">Point to calculate distance to.</param>
  55. <returns>Returns Euclidean distance between this point and
  56. <paramref name="anotherPoint"/> points.</returns>
  57. </member>
  58. <member name="M:AForge.DoublePoint.SquaredDistanceTo(AForge.DoublePoint)">
  59. <summary>
  60. Calculate squared Euclidean distance between two points.
  61. </summary>
  62. <param name="anotherPoint">Point to calculate distance to.</param>
  63. <returns>Returns squared Euclidean distance between this point and
  64. <paramref name="anotherPoint"/> points.</returns>
  65. </member>
  66. <member name="M:AForge.DoublePoint.op_Addition(AForge.DoublePoint,AForge.DoublePoint)">
  67. <summary>
  68. Addition operator - adds values of two points.
  69. </summary>
  70. <param name="point1">First point for addition.</param>
  71. <param name="point2">Second point for addition.</param>
  72. <returns>Returns new point which coordinates equal to sum of corresponding
  73. coordinates of specified points.</returns>
  74. </member>
  75. <member name="M:AForge.DoublePoint.Add(AForge.DoublePoint,AForge.DoublePoint)">
  76. <summary>
  77. Addition operator - adds values of two points.
  78. </summary>
  79. <param name="point1">First point for addition.</param>
  80. <param name="point2">Second point for addition.</param>
  81. <returns>Returns new point which coordinates equal to sum of corresponding
  82. coordinates of specified points.</returns>
  83. </member>
  84. <member name="M:AForge.DoublePoint.op_Subtraction(AForge.DoublePoint,AForge.DoublePoint)">
  85. <summary>
  86. Subtraction operator - subtracts values of two points.
  87. </summary>
  88. <param name="point1">Point to subtract from.</param>
  89. <param name="point2">Point to subtract.</param>
  90. <returns>Returns new point which coordinates equal to difference of corresponding
  91. coordinates of specified points.</returns>
  92. </member>
  93. <member name="M:AForge.DoublePoint.Subtract(AForge.DoublePoint,AForge.DoublePoint)">
  94. <summary>
  95. Subtraction operator - subtracts values of two points.
  96. </summary>
  97. <param name="point1">Point to subtract from.</param>
  98. <param name="point2">Point to subtract.</param>
  99. <returns>Returns new point which coordinates equal to difference of corresponding
  100. coordinates of specified points.</returns>
  101. </member>
  102. <member name="M:AForge.DoublePoint.op_Addition(AForge.DoublePoint,System.Double)">
  103. <summary>
  104. Addition operator - adds scalar to the specified point.
  105. </summary>
  106. <param name="point">Point to increase coordinates of.</param>
  107. <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
  108. <returns>Returns new point which coordinates equal to coordinates of
  109. the specified point increased by specified value.</returns>
  110. </member>
  111. <member name="M:AForge.DoublePoint.Add(AForge.DoublePoint,System.Double)">
  112. <summary>
  113. Addition operator - adds scalar to the specified point.
  114. </summary>
  115. <param name="point">Point to increase coordinates of.</param>
  116. <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
  117. <returns>Returns new point which coordinates equal to coordinates of
  118. the specified point increased by specified value.</returns>
  119. </member>
  120. <member name="M:AForge.DoublePoint.op_Subtraction(AForge.DoublePoint,System.Double)">
  121. <summary>
  122. Subtraction operator - subtracts scalar from the specified point.
  123. </summary>
  124. <param name="point">Point to decrease coordinates of.</param>
  125. <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
  126. <returns>Returns new point which coordinates equal to coordinates of
  127. the specified point decreased by specified value.</returns>
  128. </member>
  129. <member name="M:AForge.DoublePoint.Subtract(AForge.DoublePoint,System.Double)">
  130. <summary>
  131. Subtraction operator - subtracts scalar from the specified point.
  132. </summary>
  133. <param name="point">Point to decrease coordinates of.</param>
  134. <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
  135. <returns>Returns new point which coordinates equal to coordinates of
  136. the specified point decreased by specified value.</returns>
  137. </member>
  138. <member name="M:AForge.DoublePoint.op_Multiply(AForge.DoublePoint,System.Double)">
  139. <summary>
  140. Multiplication operator - multiplies coordinates of the specified point by scalar value.
  141. </summary>
  142. <param name="point">Point to multiply coordinates of.</param>
  143. <param name="factor">Multiplication factor.</param>
  144. <returns>Returns new point which coordinates equal to coordinates of
  145. the specified point multiplied by specified value.</returns>
  146. </member>
  147. <member name="M:AForge.DoublePoint.Multiply(AForge.DoublePoint,System.Double)">
  148. <summary>
  149. Multiplication operator - multiplies coordinates of the specified point by scalar value.
  150. </summary>
  151. <param name="point">Point to multiply coordinates of.</param>
  152. <param name="factor">Multiplication factor.</param>
  153. <returns>Returns new point which coordinates equal to coordinates of
  154. the specified point multiplied by specified value.</returns>
  155. </member>
  156. <member name="M:AForge.DoublePoint.op_Division(AForge.DoublePoint,System.Double)">
  157. <summary>
  158. Division operator - divides coordinates of the specified point by scalar value.
  159. </summary>
  160. <param name="point">Point to divide coordinates of.</param>
  161. <param name="factor">Division factor.</param>
  162. <returns>Returns new point which coordinates equal to coordinates of
  163. the specified point divided by specified value.</returns>
  164. </member>
  165. <member name="M:AForge.DoublePoint.Divide(AForge.DoublePoint,System.Double)">
  166. <summary>
  167. Division operator - divides coordinates of the specified point by scalar value.
  168. </summary>
  169. <param name="point">Point to divide coordinates of.</param>
  170. <param name="factor">Division factor.</param>
  171. <returns>Returns new point which coordinates equal to coordinates of
  172. the specified point divided by specified value.</returns>
  173. </member>
  174. <member name="M:AForge.DoublePoint.op_Equality(AForge.DoublePoint,AForge.DoublePoint)">
  175. <summary>
  176. Equality operator - checks if two points have equal coordinates.
  177. </summary>
  178. <param name="point1">First point to check.</param>
  179. <param name="point2">Second point to check.</param>
  180. <returns>Returns <see langword="true"/> if coordinates of specified
  181. points are equal.</returns>
  182. </member>
  183. <member name="M:AForge.DoublePoint.op_Inequality(AForge.DoublePoint,AForge.DoublePoint)">
  184. <summary>
  185. Inequality operator - checks if two points have different coordinates.
  186. </summary>
  187. <param name="point1">First point to check.</param>
  188. <param name="point2">Second point to check.</param>
  189. <returns>Returns <see langword="true"/> if coordinates of specified
  190. points are not equal.</returns>
  191. </member>
  192. <member name="M:AForge.DoublePoint.Equals(System.Object)">
  193. <summary>
  194. Check if this instance of <see cref="T:AForge.DoublePoint"/> equal to the specified one.
  195. </summary>
  196. <param name="obj">Another point to check equalty to.</param>
  197. <returns>Return <see langword="true"/> if objects are equal.</returns>
  198. </member>
  199. <member name="M:AForge.DoublePoint.GetHashCode">
  200. <summary>
  201. Get hash code for this instance.
  202. </summary>
  203. <returns>Returns the hash code for this instance.</returns>
  204. </member>
  205. <member name="M:AForge.DoublePoint.op_Explicit(AForge.DoublePoint)~AForge.IntPoint">
  206. <summary>
  207. Explicit conversion to <see cref="T:AForge.IntPoint"/>.
  208. </summary>
  209. <param name="point">Double precision point to convert to integer point.</param>
  210. <returns>Returns new integer point which coordinates are explicitly converted
  211. to integers from coordinates of the specified double precision point by
  212. casting double values to integers value.</returns>
  213. </member>
  214. <member name="M:AForge.DoublePoint.op_Explicit(AForge.DoublePoint)~AForge.Point">
  215. <summary>
  216. Explicit conversion to <see cref="T:AForge.Point"/>.
  217. </summary>
  218. <param name="point">Double precision point to convert to single precision point.</param>
  219. <returns>Returns new single precision point which coordinates are explicitly converted
  220. to floats from coordinates of the specified double precision point by
  221. casting double values to float value.</returns>
  222. </member>
  223. <member name="M:AForge.DoublePoint.Round">
  224. <summary>
  225. Rounds the double precision point.
  226. </summary>
  227. <returns>Returns new integer point, which coordinates equal to whole numbers
  228. nearest to the corresponding coordinates of the double precision point.</returns>
  229. </member>
  230. <member name="M:AForge.DoublePoint.ToString">
  231. <summary>
  232. Get string representation of the class.
  233. </summary>
  234. <returns>Returns string, which contains values of the point in readable form.</returns>
  235. </member>
  236. <member name="M:AForge.DoublePoint.EuclideanNorm">
  237. <summary>
  238. Calculate Euclidean norm of the vector comprised of the point's
  239. coordinates - distance from (0, 0) in other words.
  240. </summary>
  241. <returns>Returns point's distance from (0, 0) point.</returns>
  242. </member>
  243. <member name="T:AForge.DoubleRange">
  244. <summary>
  245. Represents a double range with minimum and maximum values.
  246. </summary>
  247. <remarks>
  248. <para>The class represents a double range with inclusive limits -
  249. both minimum and maximum values of the range are included into it.
  250. Mathematical notation of such range is <b>[min, max]</b>.</para>
  251. <para>Sample usage:</para>
  252. <code>
  253. // create [0.25, 1.5] range
  254. DoubleRange range1 = new DoubleRange( 0.25, 1.5 );
  255. // create [1.00, 2.25] range
  256. DoubleRange range2 = new DoubleRange( 1.00, 2.25 );
  257. // check if values is inside of the first range
  258. if ( range1.IsInside( 0.75 ) )
  259. {
  260. // ...
  261. }
  262. // check if the second range is inside of the first range
  263. if ( range1.IsInside( range2 ) )
  264. {
  265. // ...
  266. }
  267. // check if two ranges overlap
  268. if ( range1.IsOverlapping( range2 ) )
  269. {
  270. // ...
  271. }
  272. </code>
  273. </remarks>
  274. </member>
  275. <member name="P:AForge.DoubleRange.Min">
  276. <summary>
  277. Minimum value of the range.
  278. </summary>
  279. <remarks><para>The property represents minimum value (left side limit) or the range -
  280. [<b>min</b>, max].</para></remarks>
  281. </member>
  282. <member name="P:AForge.DoubleRange.Max">
  283. <summary>
  284. Maximum value of the range.
  285. </summary>
  286. <remarks><para>The property represents maximum value (right side limit) or the range -
  287. [min, <b>max</b>].</para></remarks>
  288. </member>
  289. <member name="P:AForge.DoubleRange.Length">
  290. <summary>
  291. Length of the range (deffirence between maximum and minimum values).
  292. </summary>
  293. </member>
  294. <member name="M:AForge.DoubleRange.#ctor(System.Double,System.Double)">
  295. <summary>
  296. Initializes a new instance of the <see cref="T:AForge.DoubleRange"/> class.
  297. </summary>
  298. <param name="min">Minimum value of the range.</param>
  299. <param name="max">Maximum value of the range.</param>
  300. </member>
  301. <member name="M:AForge.DoubleRange.IsInside(System.Double)">
  302. <summary>
  303. Check if the specified value is inside of the range.
  304. </summary>
  305. <param name="x">Value to check.</param>
  306. <returns><b>True</b> if the specified value is inside of the range or
  307. <b>false</b> otherwise.</returns>
  308. </member>
  309. <member name="M:AForge.DoubleRange.IsInside(AForge.DoubleRange)">
  310. <summary>
  311. Check if the specified range is inside of the range.
  312. </summary>
  313. <param name="range">Range to check.</param>
  314. <returns><b>True</b> if the specified range is inside of the range or
  315. <b>false</b> otherwise.</returns>
  316. </member>
  317. <member name="M:AForge.DoubleRange.IsOverlapping(AForge.DoubleRange)">
  318. <summary>
  319. Check if the specified range overlaps with the range.
  320. </summary>
  321. <param name="range">Range to check for overlapping.</param>
  322. <returns><b>True</b> if the specified range overlaps with the range or
  323. <b>false</b> otherwise.</returns>
  324. </member>
  325. <member name="M:AForge.DoubleRange.ToIntRange(System.Boolean)">
  326. <summary>
  327. Convert the signle precision range to integer range.
  328. </summary>
  329. <param name="provideInnerRange">Specifies if inner integer range must be returned or outer range.</param>
  330. <returns>Returns integer version of the range.</returns>
  331. <remarks>If <paramref name="provideInnerRange"/> is set to <see langword="true"/>, then the
  332. returned integer range will always fit inside of the current single precision range.
  333. If it is set to <see langword="false"/>, then current single precision range will always
  334. fit into the returned integer range.</remarks>
  335. </member>
  336. <member name="M:AForge.DoubleRange.op_Equality(AForge.DoubleRange,AForge.DoubleRange)">
  337. <summary>
  338. Equality operator - checks if two ranges have equal min/max values.
  339. </summary>
  340. <param name="range1">First range to check.</param>
  341. <param name="range2">Second range to check.</param>
  342. <returns>Returns <see langword="true"/> if min/max values of specified
  343. ranges are equal.</returns>
  344. </member>
  345. <member name="M:AForge.DoubleRange.op_Inequality(AForge.DoubleRange,AForge.DoubleRange)">
  346. <summary>
  347. Inequality operator - checks if two ranges have different min/max values.
  348. </summary>
  349. <param name="range1">First range to check.</param>
  350. <param name="range2">Second range to check.</param>
  351. <returns>Returns <see langword="true"/> if min/max values of specified
  352. ranges are not equal.</returns>
  353. </member>
  354. <member name="M:AForge.DoubleRange.Equals(System.Object)">
  355. <summary>
  356. Check if this instance of <see cref="T:AForge.Range"/> equal to the specified one.
  357. </summary>
  358. <param name="obj">Another range to check equalty to.</param>
  359. <returns>Return <see langword="true"/> if objects are equal.</returns>
  360. </member>
  361. <member name="M:AForge.DoubleRange.GetHashCode">
  362. <summary>
  363. Get hash code for this instance.
  364. </summary>
  365. <returns>Returns the hash code for this instance.</returns>
  366. </member>
  367. <member name="M:AForge.DoubleRange.ToString">
  368. <summary>
  369. Get string representation of the class.
  370. </summary>
  371. <returns>Returns string, which contains min/max values of the range in readable form.</returns>
  372. </member>
  373. <member name="T:AForge.CommunicationBufferEventArgs">
  374. <summary>
  375. Event arguments holding a buffer sent or received during some communication process.
  376. </summary>
  377. </member>
  378. <member name="P:AForge.CommunicationBufferEventArgs.MessageLength">
  379. <summary>
  380. Length of the transfered message.
  381. </summary>
  382. </member>
  383. <member name="M:AForge.CommunicationBufferEventArgs.#ctor(System.Byte[])">
  384. <summary>
  385. Initializes a new instance of the <see cref="T:AForge.CommunicationBufferEventArgs"/> class.
  386. </summary>
  387. <param name="message">Message being transfered during communication process.</param>
  388. </member>
  389. <member name="M:AForge.CommunicationBufferEventArgs.#ctor(System.Byte[],System.Int32,System.Int32)">
  390. <summary>
  391. Initializes a new instance of the <see cref="T:AForge.CommunicationBufferEventArgs"/> class.
  392. </summary>
  393. <param name="buffer">Buffer containing the message being transferred during communication process.</param>
  394. <param name="index">Starting index of the message within the buffer.</param>
  395. <param name="length">Length of the message within the buffer.</param>
  396. </member>
  397. <member name="M:AForge.CommunicationBufferEventArgs.GetMessage">
  398. <summary>
  399. Get the transfered message.
  400. </summary>
  401. <returns>Returns copy of the transfered message.</returns>
  402. </member>
  403. <member name="M:AForge.CommunicationBufferEventArgs.GetMessageString">
  404. <summary>
  405. Get the transferred message as string.
  406. </summary>
  407. <returns>Returns string encoding the transferred message.</returns>
  408. </member>
  409. <member name="T:AForge.ConnectionFailedException">
  410. <summary>
  411. Connection failed exception.
  412. </summary>
  413. <remarks><para>The exception is thrown in the case if connection to device
  414. has failed.</para>
  415. </remarks>
  416. </member>
  417. <member name="M:AForge.ConnectionFailedException.#ctor(System.String)">
  418. <summary>
  419. Initializes a new instance of the <see cref="T:AForge.ConnectionFailedException"/> class.
  420. </summary>
  421. <param name="message">Exception's message.</param>
  422. </member>
  423. <member name="T:AForge.ConnectionLostException">
  424. <summary>
  425. Connection lost exception.
  426. </summary>
  427. <remarks><para>The exception is thrown in the case if connection to device
  428. is lost. When the exception is caught, user may need to reconnect to the device.</para>
  429. </remarks>
  430. </member>
  431. <member name="M:AForge.ConnectionLostException.#ctor(System.String)">
  432. <summary>
  433. Initializes a new instance of the <see cref="T:AForge.ConnectionLostException"/> class.
  434. </summary>
  435. <param name="message">Exception's message.</param>
  436. </member>
  437. <member name="T:AForge.NotConnectedException">
  438. <summary>
  439. Not connected exception.
  440. </summary>
  441. <remarks><para>The exception is thrown in the case if connection to device
  442. is not established, but user requests for its services.</para>
  443. </remarks>
  444. </member>
  445. <member name="M:AForge.NotConnectedException.#ctor(System.String)">
  446. <summary>
  447. Initializes a new instance of the <see cref="T:AForge.NotConnectedException"/> class.
  448. </summary>
  449. <param name="message">Exception's message.</param>
  450. </member>
  451. <member name="T:AForge.DeviceBusyException">
  452. <summary>
  453. Device busy exception.
  454. </summary>
  455. <remarks><para>The exception is thrown in the case if access to certain device
  456. is not available due to the fact that it is currently busy handling other request/connection.</para>
  457. </remarks>
  458. </member>
  459. <member name="M:AForge.DeviceBusyException.#ctor(System.String)">
  460. <summary>
  461. Initializes a new instance of the <see cref="T:AForge.DeviceBusyException"/> class.
  462. </summary>
  463. <param name="message">Exception's message.</param>
  464. </member>
  465. <member name="T:AForge.DeviceErrorException">
  466. <summary>
  467. Device error exception.
  468. </summary>
  469. <remarks><para>The exception is thrown in the case if some error happens with a device, which
  470. may need to be reported to user.</para></remarks>
  471. </member>
  472. <member name="M:AForge.DeviceErrorException.#ctor(System.String)">
  473. <summary>
  474. Initializes a new instance of the <see cref="T:AForge.DeviceErrorException"/> class.
  475. </summary>
  476. <param name="message">Exception's message.</param>
  477. </member>
  478. <member name="T:AForge.IntPoint">
  479. <summary>
  480. Structure for representing a pair of coordinates of integer type.
  481. </summary>
  482. <remarks><para>The structure is used to store a pair of integer coordinates.</para>
  483. <para>Sample usage:</para>
  484. <code>
  485. // assigning coordinates in the constructor
  486. IntPoint p1 = new IntPoint( 10, 20 );
  487. // creating a point and assigning coordinates later
  488. IntPoint p2;
  489. p2.X = 30;
  490. p2.Y = 40;
  491. // calculating distance between two points
  492. float distance = p1.DistanceTo( p2 );
  493. </code>
  494. </remarks>
  495. </member>
  496. <member name="F:AForge.IntPoint.X">
  497. <summary>
  498. X coordinate.
  499. </summary>
  500. </member>
  501. <member name="F:AForge.IntPoint.Y">
  502. <summary>
  503. Y coordinate.
  504. </summary>
  505. </member>
  506. <member name="M:AForge.IntPoint.#ctor(System.Int32,System.Int32)">
  507. <summary>
  508. Initializes a new instance of the <see cref="T:AForge.IntPoint"/> structure.
  509. </summary>
  510. <param name="x">X axis coordinate.</param>
  511. <param name="y">Y axis coordinate.</param>
  512. </member>
  513. <member name="M:AForge.IntPoint.DistanceTo(AForge.IntPoint)">
  514. <summary>
  515. Calculate Euclidean distance between two points.
  516. </summary>
  517. <param name="anotherPoint">Point to calculate distance to.</param>
  518. <returns>Returns Euclidean distance between this point and
  519. <paramref name="anotherPoint"/> points.</returns>
  520. </member>
  521. <member name="M:AForge.IntPoint.SquaredDistanceTo(AForge.Point)">
  522. <summary>
  523. Calculate squared Euclidean distance between two points.
  524. </summary>
  525. <param name="anotherPoint">Point to calculate distance to.</param>
  526. <returns>Returns squared Euclidean distance between this point and
  527. <paramref name="anotherPoint"/> points.</returns>
  528. </member>
  529. <member name="M:AForge.IntPoint.op_Addition(AForge.IntPoint,AForge.IntPoint)">
  530. <summary>
  531. Addition operator - adds values of two points.
  532. </summary>
  533. <param name="point1">First point for addition.</param>
  534. <param name="point2">Second point for addition.</param>
  535. <returns>Returns new point which coordinates equal to sum of corresponding
  536. coordinates of specified points.</returns>
  537. </member>
  538. <member name="M:AForge.IntPoint.Add(AForge.IntPoint,AForge.IntPoint)">
  539. <summary>
  540. Addition operator - adds values of two points.
  541. </summary>
  542. <param name="point1">First point for addition.</param>
  543. <param name="point2">Second point for addition.</param>
  544. <returns>Returns new point which coordinates equal to sum of corresponding
  545. coordinates of specified points.</returns>
  546. </member>
  547. <member name="M:AForge.IntPoint.op_Subtraction(AForge.IntPoint,AForge.IntPoint)">
  548. <summary>
  549. Subtraction operator - subtracts values of two points.
  550. </summary>
  551. <param name="point1">Point to subtract from.</param>
  552. <param name="point2">Point to subtract.</param>
  553. <returns>Returns new point which coordinates equal to difference of corresponding
  554. coordinates of specified points.</returns>
  555. </member>
  556. <member name="M:AForge.IntPoint.Subtract(AForge.IntPoint,AForge.IntPoint)">
  557. <summary>
  558. Subtraction operator - subtracts values of two points.
  559. </summary>
  560. <param name="point1">Point to subtract from.</param>
  561. <param name="point2">Point to subtract.</param>
  562. <returns>Returns new point which coordinates equal to difference of corresponding
  563. coordinates of specified points.</returns>
  564. </member>
  565. <member name="M:AForge.IntPoint.op_Addition(AForge.IntPoint,System.Int32)">
  566. <summary>
  567. Addition operator - adds scalar to the specified point.
  568. </summary>
  569. <param name="point">Point to increase coordinates of.</param>
  570. <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
  571. <returns>Returns new point which coordinates equal to coordinates of
  572. the specified point increased by specified value.</returns>
  573. </member>
  574. <member name="M:AForge.IntPoint.Add(AForge.IntPoint,System.Int32)">
  575. <summary>
  576. Addition operator - adds scalar to the specified point.
  577. </summary>
  578. <param name="point">Point to increase coordinates of.</param>
  579. <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
  580. <returns>Returns new point which coordinates equal to coordinates of
  581. the specified point increased by specified value.</returns>
  582. </member>
  583. <member name="M:AForge.IntPoint.op_Subtraction(AForge.IntPoint,System.Int32)">
  584. <summary>
  585. Subtraction operator - subtracts scalar from the specified point.
  586. </summary>
  587. <param name="point">Point to decrease coordinates of.</param>
  588. <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
  589. <returns>Returns new point which coordinates equal to coordinates of
  590. the specified point decreased by specified value.</returns>
  591. </member>
  592. <member name="M:AForge.IntPoint.Subtract(AForge.IntPoint,System.Int32)">
  593. <summary>
  594. Subtraction operator - subtracts scalar from the specified point.
  595. </summary>
  596. <param name="point">Point to decrease coordinates of.</param>
  597. <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
  598. <returns>Returns new point which coordinates equal to coordinates of
  599. the specified point decreased by specified value.</returns>
  600. </member>
  601. <member name="M:AForge.IntPoint.op_Multiply(AForge.IntPoint,System.Int32)">
  602. <summary>
  603. Multiplication operator - multiplies coordinates of the specified point by scalar value.
  604. </summary>
  605. <param name="point">Point to multiply coordinates of.</param>
  606. <param name="factor">Multiplication factor.</param>
  607. <returns>Returns new point which coordinates equal to coordinates of
  608. the specified point multiplied by specified value.</returns>
  609. </member>
  610. <member name="M:AForge.IntPoint.Multiply(AForge.IntPoint,System.Int32)">
  611. <summary>
  612. Multiplication operator - multiplies coordinates of the specified point by scalar value.
  613. </summary>
  614. <param name="point">Point to multiply coordinates of.</param>
  615. <param name="factor">Multiplication factor.</param>
  616. <returns>Returns new point which coordinates equal to coordinates of
  617. the specified point multiplied by specified value.</returns>
  618. </member>
  619. <member name="M:AForge.IntPoint.op_Division(AForge.IntPoint,System.Int32)">
  620. <summary>
  621. Division operator - divides coordinates of the specified point by scalar value.
  622. </summary>
  623. <param name="point">Point to divide coordinates of.</param>
  624. <param name="factor">Division factor.</param>
  625. <returns>Returns new point which coordinates equal to coordinates of
  626. the specified point divided by specified value.</returns>
  627. </member>
  628. <member name="M:AForge.IntPoint.Divide(AForge.IntPoint,System.Int32)">
  629. <summary>
  630. Division operator - divides coordinates of the specified point by scalar value.
  631. </summary>
  632. <param name="point">Point to divide coordinates of.</param>
  633. <param name="factor">Division factor.</param>
  634. <returns>Returns new point which coordinates equal to coordinates of
  635. the specified point divided by specified value.</returns>
  636. </member>
  637. <member name="M:AForge.IntPoint.op_Equality(AForge.IntPoint,AForge.IntPoint)">
  638. <summary>
  639. Equality operator - checks if two points have equal coordinates.
  640. </summary>
  641. <param name="point1">First point to check.</param>
  642. <param name="point2">Second point to check.</param>
  643. <returns>Returns <see langword="true"/> if coordinates of specified
  644. points are equal.</returns>
  645. </member>
  646. <member name="M:AForge.IntPoint.op_Inequality(AForge.IntPoint,AForge.IntPoint)">
  647. <summary>
  648. Inequality operator - checks if two points have different coordinates.
  649. </summary>
  650. <param name="point1">First point to check.</param>
  651. <param name="point2">Second point to check.</param>
  652. <returns>Returns <see langword="true"/> if coordinates of specified
  653. points are not equal.</returns>
  654. </member>
  655. <member name="M:AForge.IntPoint.Equals(System.Object)">
  656. <summary>
  657. Check if this instance of <see cref="T:AForge.IntPoint"/> equal to the specified one.
  658. </summary>
  659. <param name="obj">Another point to check equalty to.</param>
  660. <returns>Return <see langword="true"/> if objects are equal.</returns>
  661. </member>
  662. <member name="M:AForge.IntPoint.GetHashCode">
  663. <summary>
  664. Get hash code for this instance.
  665. </summary>
  666. <returns>Returns the hash code for this instance.</returns>
  667. </member>
  668. <member name="M:AForge.IntPoint.op_Implicit(AForge.IntPoint)~AForge.Point">
  669. <summary>
  670. Implicit conversion to <see cref="T:AForge.Point"/>.
  671. </summary>
  672. <param name="point">Integer point to convert to single precision point.</param>
  673. <returns>Returns new single precision point which coordinates are implicitly converted
  674. to floats from coordinates of the specified integer point.</returns>
  675. </member>
  676. <member name="M:AForge.IntPoint.op_Implicit(AForge.IntPoint)~AForge.DoublePoint">
  677. <summary>
  678. Implicit conversion to <see cref="T:AForge.DoublePoint"/>.
  679. </summary>
  680. <param name="point">Integer point to convert to double precision point.</param>
  681. <returns>Returns new double precision point which coordinates are implicitly converted
  682. to doubles from coordinates of the specified integer point.</returns>
  683. </member>
  684. <member name="M:AForge.IntPoint.ToString">
  685. <summary>
  686. Get string representation of the class.
  687. </summary>
  688. <returns>Returns string, which contains values of the point in readable form.</returns>
  689. </member>
  690. <member name="M:AForge.IntPoint.EuclideanNorm">
  691. <summary>
  692. Calculate Euclidean norm of the vector comprised of the point's
  693. coordinates - distance from (0, 0) in other words.
  694. </summary>
  695. <returns>Returns point's distance from (0, 0) point.</returns>
  696. </member>
  697. <member name="T:AForge.IntRange">
  698. <summary>
  699. Represents an integer range with minimum and maximum values.
  700. </summary>
  701. <remarks>
  702. <para>The class represents an integer range with inclusive limits -
  703. both minimum and maximum values of the range are included into it.
  704. Mathematical notation of such range is <b>[min, max]</b>.</para>
  705. <para>Sample usage:</para>
  706. <code>
  707. // create [1, 10] range
  708. IntRange range1 = new IntRange( 1, 10 );
  709. // create [5, 15] range
  710. IntRange range2 = new IntRange( 5, 15 );
  711. // check if values is inside of the first range
  712. if ( range1.IsInside( 7 ) )
  713. {
  714. // ...
  715. }
  716. // check if the second range is inside of the first range
  717. if ( range1.IsInside( range2 ) )
  718. {
  719. // ...
  720. }
  721. // check if two ranges overlap
  722. if ( range1.IsOverlapping( range2 ) )
  723. {
  724. // ...
  725. }
  726. </code>
  727. </remarks>
  728. </member>
  729. <member name="P:AForge.IntRange.Min">
  730. <summary>
  731. Minimum value of the range.
  732. </summary>
  733. <remarks><para>The property represents minimum value (left side limit) or the range -
  734. [<b>min</b>, max].</para></remarks>
  735. </member>
  736. <member name="P:AForge.IntRange.Max">
  737. <summary>
  738. Maximum value of the range.
  739. </summary>
  740. <remarks><para>The property represents maximum value (right side limit) or the range -
  741. [min, <b>max</b>].</para></remarks>
  742. </member>
  743. <member name="P:AForge.IntRange.Length">
  744. <summary>
  745. Length of the range (deffirence between maximum and minimum values).
  746. </summary>
  747. </member>
  748. <member name="M:AForge.IntRange.#ctor(System.Int32,System.Int32)">
  749. <summary>
  750. Initializes a new instance of the <see cref="T:AForge.IntRange"/> structure.
  751. </summary>
  752. <param name="min">Minimum value of the range.</param>
  753. <param name="max">Maximum value of the range.</param>
  754. </member>
  755. <member name="M:AForge.IntRange.IsInside(System.Int32)">
  756. <summary>
  757. Check if the specified value is inside of the range.
  758. </summary>
  759. <param name="x">Value to check.</param>
  760. <returns><b>True</b> if the specified value is inside of the range or
  761. <b>false</b> otherwise.</returns>
  762. </member>
  763. <member name="M:AForge.IntRange.IsInside(AForge.IntRange)">
  764. <summary>
  765. Check if the specified range is inside of the range.
  766. </summary>
  767. <param name="range">Range to check.</param>
  768. <returns><b>True</b> if the specified range is inside of the range or
  769. <b>false</b> otherwise.</returns>
  770. </member>
  771. <member name="M:AForge.IntRange.IsOverlapping(AForge.IntRange)">
  772. <summary>
  773. Check if the specified range overlaps with the range.
  774. </summary>
  775. <param name="range">Range to check for overlapping.</param>
  776. <returns><b>True</b> if the specified range overlaps with the range or
  777. <b>false</b> otherwise.</returns>
  778. </member>
  779. <member name="M:AForge.IntRange.op_Implicit(AForge.IntRange)~AForge.Range">
  780. <summary>
  781. Implicit conversion to <see cref="T:AForge.Range"/>.
  782. </summary>
  783. <param name="range">Integer range to convert to single precision range.</param>
  784. <returns>Returns new single precision range which min/max values are implicitly converted
  785. to floats from min/max values of the specified integer range.</returns>
  786. </member>
  787. <member name="M:AForge.IntRange.op_Equality(AForge.IntRange,AForge.IntRange)">
  788. <summary>
  789. Equality operator - checks if two ranges have equal min/max values.
  790. </summary>
  791. <param name="range1">First range to check.</param>
  792. <param name="range2">Second range to check.</param>
  793. <returns>Returns <see langword="true"/> if min/max values of specified
  794. ranges are equal.</returns>
  795. </member>
  796. <member name="M:AForge.IntRange.op_Inequality(AForge.IntRange,AForge.IntRange)">
  797. <summary>
  798. Inequality operator - checks if two ranges have different min/max values.
  799. </summary>
  800. <param name="range1">First range to check.</param>
  801. <param name="range2">Second range to check.</param>
  802. <returns>Returns <see langword="true"/> if min/max values of specified
  803. ranges are not equal.</returns>
  804. </member>
  805. <member name="M:AForge.IntRange.Equals(System.Object)">
  806. <summary>
  807. Check if this instance of <see cref="T:AForge.Range"/> equal to the specified one.
  808. </summary>
  809. <param name="obj">Another range to check equalty to.</param>
  810. <returns>Return <see langword="true"/> if objects are equal.</returns>
  811. </member>
  812. <member name="M:AForge.IntRange.GetHashCode">
  813. <summary>
  814. Get hash code for this instance.
  815. </summary>
  816. <returns>Returns the hash code for this instance.</returns>
  817. </member>
  818. <member name="M:AForge.IntRange.ToString">
  819. <summary>
  820. Get string representation of the class.
  821. </summary>
  822. <returns>Returns string, which contains min/max values of the range in readable form.</returns>
  823. </member>
  824. <member name="T:AForge.Parallel">
  825. <summary>
  826. The class provides support for parallel computations, paralleling loop's iterations.
  827. </summary>
  828. <remarks><para>The class allows to parallel loop's iteration computing them in separate threads,
  829. what allows their simultaneous execution on multiple CPUs/cores.
  830. </para></remarks>
  831. </member>
  832. <member name="T:AForge.Parallel.ForLoopBody">
  833. <summary>
  834. Delegate defining for-loop's body.
  835. </summary>
  836. <param name="index">Loop's index.</param>
  837. </member>
  838. <member name="P:AForge.Parallel.ThreadsCount">
  839. <summary>
  840. Number of threads used for parallel computations.
  841. </summary>
  842. <remarks><para>The property sets how many worker threads are created for paralleling
  843. loops' computations.</para>
  844. <para>By default the property is set to number of CPU's in the system
  845. (see <see cref="P:System.Environment.ProcessorCount"/>).</para>
  846. </remarks>
  847. </member>
  848. <member name="M:AForge.Parallel.For(System.Int32,System.Int32,AForge.Parallel.ForLoopBody)">
  849. <summary>
  850. Executes a for-loop in which iterations may run in parallel.
  851. </summary>
  852. <param name="start">Loop's start index.</param>
  853. <param name="stop">Loop's stop index.</param>
  854. <param name="loopBody">Loop's body.</param>
  855. <remarks><para>The method is used to parallel for-loop running its iterations in
  856. different threads. The <b>start</b> and <b>stop</b> parameters define loop's
  857. starting and ending loop's indexes. The number of iterations is equal to <b>stop - start</b>.
  858. </para>
  859. <para>Sample usage:</para>
  860. <code>
  861. Parallel.For( 0, 20, delegate( int i )
  862. // which is equivalent to
  863. // for ( int i = 0; i &lt; 20; i++ )
  864. {
  865. System.Diagnostics.Debug.WriteLine( "Iteration: " + i );
  866. // ...
  867. } );
  868. </code>
  869. </remarks>
  870. </member>
  871. <member name="T:AForge.Point">
  872. <summary>
  873. Structure for representing a pair of coordinates of float type.
  874. </summary>
  875. <remarks><para>The structure is used to store a pair of floating point
  876. coordinates with single precision.</para>
  877. <para>Sample usage:</para>
  878. <code>
  879. // assigning coordinates in the constructor
  880. Point p1 = new Point( 10, 20 );
  881. // creating a point and assigning coordinates later
  882. Point p2;
  883. p2.X = 30;
  884. p2.Y = 40;
  885. // calculating distance between two points
  886. float distance = p1.DistanceTo( p2 );
  887. </code>
  888. </remarks>
  889. </member>
  890. <member name="F:AForge.Point.X">
  891. <summary>
  892. X coordinate.
  893. </summary>
  894. </member>
  895. <member name="F:AForge.Point.Y">
  896. <summary>
  897. Y coordinate.
  898. </summary>
  899. </member>
  900. <member name="M:AForge.Point.#ctor(System.Single,System.Single)">
  901. <summary>
  902. Initializes a new instance of the <see cref="T:AForge.Point"/> structure.
  903. </summary>
  904. <param name="x">X axis coordinate.</param>
  905. <param name="y">Y axis coordinate.</param>
  906. </member>
  907. <member name="M:AForge.Point.DistanceTo(AForge.Point)">
  908. <summary>
  909. Calculate Euclidean distance between two points.
  910. </summary>
  911. <param name="anotherPoint">Point to calculate distance to.</param>
  912. <returns>Returns Euclidean distance between this point and
  913. <paramref name="anotherPoint"/> points.</returns>
  914. </member>
  915. <member name="M:AForge.Point.SquaredDistanceTo(AForge.Point)">
  916. <summary>
  917. Calculate squared Euclidean distance between two points.
  918. </summary>
  919. <param name="anotherPoint">Point to calculate distance to.</param>
  920. <returns>Returns squared Euclidean distance between this point and
  921. <paramref name="anotherPoint"/> points.</returns>
  922. </member>
  923. <member name="M:AForge.Point.op_Addition(AForge.Point,AForge.Point)">
  924. <summary>
  925. Addition operator - adds values of two points.
  926. </summary>
  927. <param name="point1">First point for addition.</param>
  928. <param name="point2">Second point for addition.</param>
  929. <returns>Returns new point which coordinates equal to sum of corresponding
  930. coordinates of specified points.</returns>
  931. </member>
  932. <member name="M:AForge.Point.Add(AForge.Point,AForge.Point)">
  933. <summary>
  934. Addition operator - adds values of two points.
  935. </summary>
  936. <param name="point1">First point for addition.</param>
  937. <param name="point2">Second point for addition.</param>
  938. <returns>Returns new point which coordinates equal to sum of corresponding
  939. coordinates of specified points.</returns>
  940. </member>
  941. <member name="M:AForge.Point.op_Subtraction(AForge.Point,AForge.Point)">
  942. <summary>
  943. Subtraction operator - subtracts values of two points.
  944. </summary>
  945. <param name="point1">Point to subtract from.</param>
  946. <param name="point2">Point to subtract.</param>
  947. <returns>Returns new point which coordinates equal to difference of corresponding
  948. coordinates of specified points.</returns>
  949. </member>
  950. <member name="M:AForge.Point.Subtract(AForge.Point,AForge.Point)">
  951. <summary>
  952. Subtraction operator - subtracts values of two points.
  953. </summary>
  954. <param name="point1">Point to subtract from.</param>
  955. <param name="point2">Point to subtract.</param>
  956. <returns>Returns new point which coordinates equal to difference of corresponding
  957. coordinates of specified points.</returns>
  958. </member>
  959. <member name="M:AForge.Point.op_Addition(AForge.Point,System.Single)">
  960. <summary>
  961. Addition operator - adds scalar to the specified point.
  962. </summary>
  963. <param name="point">Point to increase coordinates of.</param>
  964. <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
  965. <returns>Returns new point which coordinates equal to coordinates of
  966. the specified point increased by specified value.</returns>
  967. </member>
  968. <member name="M:AForge.Point.Add(AForge.Point,System.Single)">
  969. <summary>
  970. Addition operator - adds scalar to the specified point.
  971. </summary>
  972. <param name="point">Point to increase coordinates of.</param>
  973. <param name="valueToAdd">Value to add to coordinates of the specified point.</param>
  974. <returns>Returns new point which coordinates equal to coordinates of
  975. the specified point increased by specified value.</returns>
  976. </member>
  977. <member name="M:AForge.Point.op_Subtraction(AForge.Point,System.Single)">
  978. <summary>
  979. Subtraction operator - subtracts scalar from the specified point.
  980. </summary>
  981. <param name="point">Point to decrease coordinates of.</param>
  982. <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
  983. <returns>Returns new point which coordinates equal to coordinates of
  984. the specified point decreased by specified value.</returns>
  985. </member>
  986. <member name="M:AForge.Point.Subtract(AForge.Point,System.Single)">
  987. <summary>
  988. Subtraction operator - subtracts scalar from the specified point.
  989. </summary>
  990. <param name="point">Point to decrease coordinates of.</param>
  991. <param name="valueToSubtract">Value to subtract from coordinates of the specified point.</param>
  992. <returns>Returns new point which coordinates equal to coordinates of
  993. the specified point decreased by specified value.</returns>
  994. </member>
  995. <member name="M:AForge.Point.op_Multiply(AForge.Point,System.Single)">
  996. <summary>
  997. Multiplication operator - multiplies coordinates of the specified point by scalar value.
  998. </summary>
  999. <param name="point">Point to multiply coordinates of.</param>
  1000. <param name="factor">Multiplication factor.</param>
  1001. <returns>Returns new point which coordinates equal to coordinates of
  1002. the specified point multiplied by specified value.</returns>
  1003. </member>
  1004. <member name="M:AForge.Point.Multiply(AForge.Point,System.Single)">
  1005. <summary>
  1006. Multiplication operator - multiplies coordinates of the specified point by scalar value.
  1007. </summary>
  1008. <param name="point">Point to multiply coordinates of.</param>
  1009. <param name="factor">Multiplication factor.</param>
  1010. <returns>Returns new point which coordinates equal to coordinates of
  1011. the specified point multiplied by specified value.</returns>
  1012. </member>
  1013. <member name="M:AForge.Point.op_Division(AForge.Point,System.Single)">
  1014. <summary>
  1015. Division operator - divides coordinates of the specified point by scalar value.
  1016. </summary>
  1017. <param name="point">Point to divide coordinates of.</param>
  1018. <param name="factor">Division factor.</param>
  1019. <returns>Returns new point which coordinates equal to coordinates of
  1020. the specified point divided by specified value.</returns>
  1021. </member>
  1022. <member name="M:AForge.Point.Divide(AForge.Point,System.Single)">
  1023. <summary>
  1024. Division operator - divides coordinates of the specified point by scalar value.
  1025. </summary>
  1026. <param name="point">Point to divide coordinates of.</param>
  1027. <param name="factor">Division factor.</param>
  1028. <returns>Returns new point which coordinates equal to coordinates of
  1029. the specified point divided by specified value.</returns>
  1030. </member>
  1031. <member name="M:AForge.Point.op_Equality(AForge.Point,AForge.Point)">
  1032. <summary>
  1033. Equality operator - checks if two points have equal coordinates.
  1034. </summary>
  1035. <param name="point1">First point to check.</param>
  1036. <param name="point2">Second point to check.</param>
  1037. <returns>Returns <see langword="true"/> if coordinates of specified
  1038. points are equal.</returns>
  1039. </member>
  1040. <member name="M:AForge.Point.op_Inequality(AForge.Point,AForge.Point)">
  1041. <summary>
  1042. Inequality operator - checks if two points have different coordinates.
  1043. </summary>
  1044. <param name="point1">First point to check.</param>
  1045. <param name="point2">Second point to check.</param>
  1046. <returns>Returns <see langword="true"/> if coordinates of specified
  1047. points are not equal.</returns>
  1048. </member>
  1049. <member name="M:AForge.Point.Equals(System.Object)">
  1050. <summary>
  1051. Check if this instance of <see cref="T:AForge.Point"/> equal to the specified one.
  1052. </summary>
  1053. <param name="obj">Another point to check equalty to.</param>
  1054. <returns>Return <see langword="true"/> if objects are equal.</returns>
  1055. </member>
  1056. <member name="M:AForge.Point.GetHashCode">
  1057. <summary>
  1058. Get hash code for this instance.
  1059. </summary>
  1060. <returns>Returns the hash code for this instance.</returns>
  1061. </member>
  1062. <member name="M:AForge.Point.op_Explicit(AForge.Point)~AForge.IntPoint">
  1063. <summary>
  1064. Explicit conversion to <see cref="T:AForge.IntPoint"/>.
  1065. </summary>
  1066. <param name="point">Single precision point to convert to integer point.</param>
  1067. <returns>Returns new integer point which coordinates are explicitly converted
  1068. to integers from coordinates of the specified single precision point by
  1069. casting float values to integers value.</returns>
  1070. </member>
  1071. <member name="M:AForge.Point.op_Implicit(AForge.Point)~AForge.DoublePoint">
  1072. <summary>
  1073. Implicit conversion to <see cref="T:AForge.DoublePoint"/>.
  1074. </summary>
  1075. <param name="point">Single precision point to convert to double precision point.</param>
  1076. <returns>Returns new double precision point which coordinates are implicitly converted
  1077. to doubles from coordinates of the specified single precision point.</returns>
  1078. </member>
  1079. <member name="M:AForge.Point.Round">
  1080. <summary>
  1081. Rounds the single precision point.
  1082. </summary>
  1083. <returns>Returns new integer point, which coordinates equal to whole numbers
  1084. nearest to the corresponding coordinates of the single precision point.</returns>
  1085. </member>
  1086. <member name="M:AForge.Point.ToString">
  1087. <summary>
  1088. Get string representation of the class.
  1089. </summary>
  1090. <returns>Returns string, which contains values of the point in readable form.</returns>
  1091. </member>
  1092. <member name="M:AForge.Point.EuclideanNorm">
  1093. <summary>
  1094. Calculate Euclidean norm of the vector comprised of the point's
  1095. coordinates - distance from (0, 0) in other words.
  1096. </summary>
  1097. <returns>Returns point's distance from (0, 0) point.</returns>
  1098. </member>
  1099. <member name="T:AForge.PolishExpression">
  1100. <summary>
  1101. Evaluator of expressions written in reverse polish notation.
  1102. </summary>
  1103. <remarks><para>The class evaluates expressions writen in reverse postfix polish notation.</para>
  1104. <para>The list of supported functuins is:</para>
  1105. <list type="bullet">
  1106. <item><b>Arithmetic functions</b>: +, -, *, /;</item>
  1107. <item><b>sin</b> - sine;</item>
  1108. <item><b>cos</b> - cosine;</item>
  1109. <item><b>ln</b> - natural logarithm;</item>
  1110. <item><b>exp</b> - exponent;</item>
  1111. <item><b>sqrt</b> - square root.</item>
  1112. </list>
  1113. <para>Arguments for these functions could be as usual constants, written as numbers, as variables,
  1114. writen as $&lt;var_number&gt; (<b>$2</b>, for example). The variable number is zero based index
  1115. of variables array.</para>
  1116. <para>Sample usage:</para>
  1117. <code>
  1118. // expression written in polish notation
  1119. string expression = "2 $0 / 3 $1 * +";
  1120. // variables for the expression
  1121. double[] vars = new double[] { 3, 4 };
  1122. // expression evaluation
  1123. double result = PolishExpression.Evaluate( expression, vars );
  1124. </code>
  1125. </remarks>
  1126. </member>
  1127. <member name="M:AForge.PolishExpression.Evaluate(System.String,System.Double[])">
  1128. <summary>
  1129. Evaluates specified expression.
  1130. </summary>
  1131. <param name="expression">Expression written in postfix polish notation.</param>
  1132. <param name="variables">Variables for the expression.</param>
  1133. <returns>Evaluated value of the expression.</returns>
  1134. <exception cref="T:System.ArgumentException">Unsupported function is used in the expression.</exception>
  1135. <exception cref="T:System.ArgumentException">Incorrect postfix polish expression.</exception>
  1136. </member>
  1137. <member name="T:AForge.Range">
  1138. <summary>
  1139. Represents a range with minimum and maximum values, which are single precision numbers (floats).
  1140. </summary>
  1141. <remarks>
  1142. <para>The class represents a single precision range with inclusive limits -
  1143. both minimum and maximum values of the range are included into it.
  1144. Mathematical notation of such range is <b>[min, max]</b>.</para>
  1145. <para>Sample usage:</para>
  1146. <code>
  1147. // create [0.25, 1.5] range
  1148. Range range1 = new Range( 0.25f, 1.5f );
  1149. // create [1.00, 2.25] range
  1150. Range range2 = new Range( 1.00f, 2.25f );
  1151. // check if values is inside of the first range
  1152. if ( range1.IsInside( 0.75f ) )
  1153. {
  1154. // ...
  1155. }
  1156. // check if the second range is inside of the first range
  1157. if ( range1.IsInside( range2 ) )
  1158. {
  1159. // ...
  1160. }
  1161. // check if two ranges overlap
  1162. if ( range1.IsOverlapping( range2 ) )
  1163. {
  1164. // ...
  1165. }
  1166. </code>
  1167. </remarks>
  1168. </member>
  1169. <member name="P:AForge.Range.Min">
  1170. <summary>
  1171. Minimum value of the range.
  1172. </summary>
  1173. <remarks><para>The property represents minimum value (left side limit) or the range -
  1174. [<b>min</b>, max].</para></remarks>
  1175. </member>
  1176. <member name="P:AForge.Range.Max">
  1177. <summary>
  1178. Maximum value of the range.
  1179. </summary>
  1180. <remarks><para>The property represents maximum value (right side limit) or the range -
  1181. [min, <b>max</b>].</para></remarks>
  1182. </member>
  1183. <member name="P:AForge.Range.Length">
  1184. <summary>
  1185. Length of the range (deffirence between maximum and minimum values).
  1186. </summary>
  1187. </member>
  1188. <member name="M:AForge.Range.#ctor(System.Single,System.Single)">
  1189. <summary>
  1190. Initializes a new instance of the <see cref="T:AForge.Range"/> structure.
  1191. </summary>
  1192. <param name="min">Minimum value of the range.</param>
  1193. <param name="max">Maximum value of the range.</param>
  1194. </member>
  1195. <member name="M:AForge.Range.IsInside(System.Single)">
  1196. <summary>
  1197. Check if the specified value is inside of the range.
  1198. </summary>
  1199. <param name="x">Value to check.</param>
  1200. <returns><b>True</b> if the specified value is inside of the range or
  1201. <b>false</b> otherwise.</returns>
  1202. </member>
  1203. <member name="M:AForge.Range.IsInside(AForge.Range)">
  1204. <summary>
  1205. Check if the specified range is inside of the range.
  1206. </summary>
  1207. <param name="range">Range to check.</param>
  1208. <returns><b>True</b> if the specified range is inside of the range or
  1209. <b>false</b> otherwise.</returns>
  1210. </member>
  1211. <member name="M:AForge.Range.IsOverlapping(AForge.Range)">
  1212. <summary>
  1213. Check if the specified range overlaps with the range.
  1214. </summary>
  1215. <param name="range">Range to check for overlapping.</param>
  1216. <returns><b>True</b> if the specified range overlaps with the range or
  1217. <b>false</b> otherwise.</returns>
  1218. </member>
  1219. <member name="M:AForge.Range.ToIntRange(System.Boolean)">
  1220. <summary>
  1221. Convert the signle precision range to integer range.
  1222. </summary>
  1223. <param name="provideInnerRange">Specifies if inner integer range must be returned or outer range.</param>
  1224. <returns>Returns integer version of the range.</returns>
  1225. <remarks>If <paramref name="provideInnerRange"/> is set to <see langword="true"/>, then the
  1226. returned integer range will always fit inside of the current single precision range.
  1227. If it is set to <see langword="false"/>, then current single precision range will always
  1228. fit into the returned integer range.</remarks>
  1229. </member>
  1230. <member name="M:AForge.Range.op_Equality(AForge.Range,AForge.Range)">
  1231. <summary>
  1232. Equality operator - checks if two ranges have equal min/max values.
  1233. </summary>
  1234. <param name="range1">First range to check.</param>
  1235. <param name="range2">Second range to check.</param>
  1236. <returns>Returns <see langword="true"/> if min/max values of specified
  1237. ranges are equal.</returns>
  1238. </member>
  1239. <member name="M:AForge.Range.op_Inequality(AForge.Range,AForge.Range)">
  1240. <summary>
  1241. Inequality operator - checks if two ranges have different min/max values.
  1242. </summary>
  1243. <param name="range1">First range to check.</param>
  1244. <param name="range2">Second range to check.</param>
  1245. <returns>Returns <see langword="true"/> if min/max values of specified
  1246. ranges are not equal.</returns>
  1247. </member>
  1248. <member name="M:AForge.Range.Equals(System.Object)">
  1249. <summary>
  1250. Check if this instance of <see cref="T:AForge.Range"/> equal to the specified one.
  1251. </summary>
  1252. <param name="obj">Another range to check equalty to.</param>
  1253. <returns>Return <see langword="true"/> if objects are equal.</returns>
  1254. </member>
  1255. <member name="M:AForge.Range.GetHashCode">
  1256. <summary>
  1257. Get hash code for this instance.
  1258. </summary>
  1259. <returns>Returns the hash code for this instance.</returns>
  1260. </member>
  1261. <member name="M:AForge.Range.ToString">
  1262. <summary>
  1263. Get string representation of the class.
  1264. </summary>
  1265. <returns>Returns string, which contains min/max values of the range in readable form.</returns>
  1266. </member>
  1267. <member name="T:AForge.SystemTools">
  1268. <summary>
  1269. Set of systems tools.
  1270. </summary>
  1271. <remarks><para>The class is a container of different system tools, which are used
  1272. across the framework. Some of these tools are platform specific, so their
  1273. implementation is different on different platform, like .NET and Mono.</para>
  1274. </remarks>
  1275. </member>
  1276. <member name="M:AForge.SystemTools.CopyUnmanagedMemory(System.IntPtr,System.IntPtr,System.Int32)">
  1277. <summary>
  1278. Copy block of unmanaged memory.
  1279. </summary>
  1280. <param name="dst">Destination pointer.</param>
  1281. <param name="src">Source pointer.</param>
  1282. <param name="count">Memory block's length to copy.</param>
  1283. <returns>Return's value of <paramref name="dst"/> - pointer to destination.</returns>
  1284. <remarks><para>This function is required because of the fact that .NET does
  1285. not provide any way to copy unmanaged blocks, but provides only methods to
  1286. copy from unmanaged memory to managed memory and vise versa.</para></remarks>
  1287. </member>
  1288. <member name="M:AForge.SystemTools.CopyUnmanagedMemory(System.Byte*,System.Byte*,System.Int32)">
  1289. <summary>
  1290. Copy block of unmanaged memory.
  1291. </summary>
  1292. <param name="dst">Destination pointer.</param>
  1293. <param name="src">Source pointer.</param>
  1294. <param name="count">Memory block's length to copy.</param>
  1295. <returns>Return's value of <paramref name="dst"/> - pointer to destination.</returns>
  1296. <remarks><para>This function is required because of the fact that .NET does
  1297. not provide any way to copy unmanaged blocks, but provides only methods to
  1298. copy from unmanaged memory to managed memory and vise versa.</para></remarks>
  1299. </member>
  1300. <member name="M:AForge.SystemTools.SetUnmanagedMemory(System.IntPtr,System.Int32,System.Int32)">
  1301. <summary>
  1302. Fill memory region with specified value.
  1303. </summary>
  1304. <param name="dst">Destination pointer.</param>
  1305. <param name="filler">Filler byte's value.</param>
  1306. <param name="count">Memory block's length to fill.</param>
  1307. <returns>Return's value of <paramref name="dst"/> - pointer to destination.</returns>
  1308. </member>
  1309. <member name="M:AForge.SystemTools.SetUnmanagedMemory(System.Byte*,System.Int32,System.Int32)">
  1310. <summary>
  1311. Fill memory region with specified value.
  1312. </summary>
  1313. <param name="dst">Destination pointer.</param>
  1314. <param name="filler">Filler byte's value.</param>
  1315. <param name="count">Memory block's length to fill.</param>
  1316. <returns>Return's value of <paramref name="dst"/> - pointer to destination.</returns>
  1317. </member>
  1318. <member name="T:AForge.ThreadSafeRandom">
  1319. <summary>
  1320. Thread safe version of the <see cref="T:System.Random"/> class.
  1321. </summary>
  1322. <remarks><para>The class inherits the <see cref="T:System.Random"/> and overrides
  1323. its random numbers generation methods providing thread safety by guarding call
  1324. to the base class with a lock. See documentation to <see cref="T:System.Random"/> for
  1325. additional information about the base class.</para></remarks>
  1326. </member>
  1327. <member name="M:AForge.ThreadSafeRandom.#ctor">
  1328. <summary>
  1329. Initializes a new instance of the <see cref="T:AForge.ThreadSafeRandom"/> class.
  1330. </summary>
  1331. <remarks>See <see cref="M:System.Random.Next"/> for more information.</remarks>
  1332. </member>
  1333. <member name="M:AForge.ThreadSafeRandom.#ctor(System.Int32)">
  1334. <summary>
  1335. Initializes a new instance of the <see cref="T:AForge.ThreadSafeRandom"/> class.
  1336. </summary>
  1337. <remarks>A number used to calculate a starting value for the pseudo-random number sequence.
  1338. If a negative number is specified, the absolute value of the number is used.</remarks>
  1339. <remarks>See <see cref="M:System.Random.Next"/> for more information.</remarks>
  1340. </member>
  1341. <member name="M:AForge.ThreadSafeRandom.Next">
  1342. <summary>
  1343. Returns a nonnegative random number.
  1344. </summary>
  1345. <returns>Returns a 32-bit signed integer greater than or equal to zero and less than
  1346. <see cref="F:System.Int32.MaxValue"/>.</returns>
  1347. <remarks>See <see cref="M:System.Random.Next"/> for more information.</remarks>
  1348. </member>
  1349. <member name="M:AForge.ThreadSafeRandom.Next(System.Int32)">
  1350. <summary>
  1351. Returns a nonnegative random number less than the specified maximum.
  1352. </summary>
  1353. <param name="maxValue">The exclusive upper bound of the random number to be generated.
  1354. <paramref name="maxValue"/> must be greater than or equal to zero.</param>
  1355. <returns>Returns a 32-bit signed integer greater than or equal to zero, and less than <paramref name="maxValue"/>;
  1356. that is, the range of return values ordinarily includes zero but not <paramref name="maxValue"/>.</returns>
  1357. <remarks>See <see cref="M:System.Random.Next(System.Int32)"/> for more information.</remarks>
  1358. </member>
  1359. <member name="M:AForge.ThreadSafeRandom.Next(System.Int32,System.Int32)">
  1360. <summary>
  1361. Returns a random number within a specified range.
  1362. </summary>
  1363. <param name="minValue">The inclusive lower bound of the random number returned.</param>
  1364. <param name="maxValue">The exclusive upper bound of the random number returned.
  1365. <paramref name="maxValue"/> must be greater than or equal to <paramref name="minValue"/>.</param>
  1366. <returns>Returns a 32-bit signed integer greater than or equal to <paramref name="minValue"/> and less
  1367. than <paramref name="maxValue"/>; that is, the range of return values includes
  1368. <paramref name="minValue"/> but not <paramref name="maxValue"/>.</returns>
  1369. <remarks>See <see cref="M:System.Random.Next(System.Int32,System.Int32)"/> for more information.</remarks>
  1370. </member>
  1371. <member name="M:AForge.ThreadSafeRandom.NextBytes(System.Byte[])">
  1372. <summary>
  1373. Fills the elements of a specified array of bytes with random numbers.
  1374. </summary>
  1375. <param name="buffer">An array of bytes to contain random numbers.</param>
  1376. <remarks>See <see cref="M:System.Random.NextBytes(System.Byte[])"/> for more information.</remarks>
  1377. </member>
  1378. <member name="M:AForge.ThreadSafeRandom.NextDouble">
  1379. <summary>
  1380. Returns a random number between 0.0 and 1.0.
  1381. </summary>
  1382. <returns>Returns a double-precision floating point number greater than or equal to 0.0, and less than 1.0.</returns>
  1383. <remarks>See <see cref="M:System.Random.NextDouble"/> for more information.</remarks>
  1384. </member>
  1385. </members>
  1386. </doc>