HKL reference with coord-like behaviour. More...
#include <hkl_info.h>
Inheritance diagram for clipper::HKL_info::HKL_reference_coord:
Public Member Functions | |
| HKL_reference_coord () | |
| Null constructor. | |
| HKL_reference_coord (const HKL_info &hklinfo_, const HKL &hkl) | |
| Constructor: takes parent HKL_info and initial HKL. | |
| const HKL & | hkl () const |
| return the current HKL | |
| const int & | sym () const |
| get current symop number | |
| const bool & | friedel () const |
| get current friedel flag | |
| HKL_reference_coord & | set_hkl (const HKL &hkl__) |
| assign from HKL | |
| HKL_reference_coord & | next () |
| increment to next reflection | |
| HKL_reference_coord & | next_h () |
| increment h | |
| HKL_reference_coord & | next_k () |
| increment k | |
| HKL_reference_coord & | next_l () |
| increment l | |
| HKL_reference_coord & | prev_h () |
| decrement h | |
| HKL_reference_coord & | prev_k () |
| decrement k | |
| HKL_reference_coord & | prev_l () |
| decrement l | |
| HKL_reference_coord & | operator= (const HKL &hkl__) |
| operator assign from HKL | |
| const HKL_info & | base_hkl_info () const |
| return the parent HKL_info | |
| const int & | index () const |
| return the current index (-1 if invalid) | |
| const ftype | invresolsq () const |
| return the inv resol sq for the reflection (assumes index valid) | |
| bool | last () const |
| test if index has gone past last reflection | |
Protected Attributes | |
| HKL | hkl_ |
| int | sym_ |
| bool | friedel_ |
Detailed Description
HKL reference with coord-like behaviour.
This is a reference to an HKL. It behaves like an HKL, but also stores the index of the corresponding reflection in the reflection list, if it exists, and the symmetry and friedel operators required to get there.
- Note:
- The following methods are inherited from HKL_reference_base but are documented here for convenience: base_hkl_info(), index(), invresolsq(), last().
Member Function Documentation
| HKL_reference_coord& clipper::HKL_info::HKL_reference_coord::set_hkl | ( | const HKL & | hkl__ | ) | [inline] |
assign from HKL
The new HKL must exist in the reflection list. The calculation is optimised for the case when the new HKL is near the old one.
References clipper::HKL_info::find_sym(), clipper::HKL_info::index_of(), clipper::HKL_info::isymop, and clipper::HKL::transform().
Referenced by next_h(), next_k(), next_l(), operator=(), prev_h(), prev_k(), and prev_l().
The documentation for this class was generated from the following file:
